org.eclipse.jpt.jpa.core.resource.java
Interface OrderByAnnotation

All Superinterfaces:

Annotation, JavaResourceModel, Model

public interface OrderByAnnotation
extends Annotation

Corresponds to the JPA annotation javax.persistence.OrderBy

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

2.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceModel

JavaResourceModel.FileTransformer, JavaResourceModel.Root

Field Summary

static String	ANNOTATION_NAME
static String	VALUE_PROPERTY

Fields inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceModel

FILE_TRANSFORMER

Method Summary

String	getValue() Corresponds to the 'value' element of the OrderBy annotation.
TextRange	getValueTextRange() Return the TextRange for the 'value' element.
void	setValue(String value) Corresponds to the 'value' element of the OrderBy annotation.

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.Annotation

getAnnotationName, getAstAnnotation, initialize, initialize, isUnset, newAnnotation, removeAnnotation, synchronizeWith, synchronizeWith

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceModel

getFile, getJavaResourceCompilationUnit, getParent, getRoot, getTextRange

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Field Detail

ANNOTATION_NAME

static final String ANNOTATION_NAME

See Also:

Constant Field Values

VALUE_PROPERTY

static final String VALUE_PROPERTY

See Also:

Constant Field Values

Method Detail

getValue

String getValue()

Corresponds to the 'value' element of the OrderBy annotation. Return null if the element does not exist in the annotation.

setValue

void setValue(String value)

Corresponds to the 'value' element of the OrderBy annotation. Setting the element to null will not remove the OrderBy annotation.

getValueTextRange

TextRange getValueTextRange()

Return the TextRange for the 'value' element. If the element does not exist return the TextRange for the OrderBy annotation.