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

All Superinterfaces:
Annotation, JavaResourceNode, Model
All Known Subinterfaces:
MapKeyTemporal2_0Annotation

public interface TemporalAnnotation
extends Annotation

Corresponds to the JPA annotation javax.persistence.Temporal 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
Version:
2.2

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.resource.java.JavaResourceNode
JavaResourceNode.Root
 
Field Summary
static java.lang.String ANNOTATION_NAME
           
static java.lang.String VALUE_PROPERTY
           
 
Method Summary
 TemporalType getValue()
          Corresponds to the 'value' element of the Temporal annotation.
 TextRange getValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the 'value' element.
 void setValue(TemporalType value)
          Corresponds to the 'value' element of the Temporal annotation.
 
Methods inherited from interface org.eclipse.jpt.jpa.core.resource.java.Annotation
getAnnotationName, getAstAnnotation, isUnset, newAnnotation, removeAnnotation, restoreFrom, storeOn
 
Methods inherited from interface org.eclipse.jpt.jpa.core.resource.java.JavaResourceNode
getFile, getJavaResourceCompilationUnit, getParent, getRoot, getTextRange, initialize, synchronizeWith
 
Methods inherited from interface org.eclipse.jpt.common.utility.model.Model
addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener
 

Field Detail

ANNOTATION_NAME

static final java.lang.String ANNOTATION_NAME
See Also:
Constant Field Values

VALUE_PROPERTY

static final java.lang.String VALUE_PROPERTY
See Also:
Constant Field Values
Method Detail

getValue

TemporalType getValue()
Corresponds to the 'value' element of the Temporal annotation. Return null if the element does not exist in Java.


setValue

void setValue(TemporalType value)
Corresponds to the 'value' element of the Temporal annotation. Set to null to remove the element.


getValueTextRange

TextRange getValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the 'value' element. If the element does not exist return the TextRange for the Temporal annotation.