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

All Superinterfaces:

Annotation, JavaResourceNode, Model

All Known Subinterfaces:

EnumeratedAnnotation, MapKeyEnumerated2_0Annotation

public interface BaseEnumeratedAnnotation
extends Annotation

Corresponds to the JPA annotations:

• javax.persistence.Enumerated
• javax.persistence.MapKeyEnumerated

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.JavaResourceNode

JavaResourceNode.FileTransformer, JavaResourceNode.Root

Field Summary

static String

VALUE_PROPERTY

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

FILE_TRANSFORMER

Method Summary

EnumType	getValue() Corresponds to the 'value' element of the Enumerated annotation.
TextRange	getValueTextRange() Return the TextRange for the 'value' element.
void	setValue(EnumType value) Corresponds to the 'value' element of the Enumerated 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.JavaResourceNode

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

VALUE_PROPERTY

static final String VALUE_PROPERTY

See Also:

Constant Field Values

Method Detail

getValue

EnumType getValue()

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

setValue

void setValue(EnumType value)

Corresponds to the 'value' element of the Enumerated annotation. Set to null to remove the element.

getValueTextRange

TextRange getValueTextRange()

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