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

All Superinterfaces:
Annotation, GeneratorAnnotation, JavaResourceNode, Model
All Known Subinterfaces:
SequenceGenerator2_0Annotation

public interface SequenceGeneratorAnnotation
extends GeneratorAnnotation

Corresponds to the JPA annotation javax.persistence.SequenceGenerator 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.1

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 SEQUENCE_NAME_PROPERTY
           
 
Fields inherited from interface org.eclipse.jpt.jpa.core.resource.java.GeneratorAnnotation
ALLOCATION_SIZE_PROPERTY, INITIAL_VALUE_PROPERTY, NAME_PROPERTY
 
Method Summary
 java.lang.String getSequenceName()
          Corresponds to the 'sequenceName' element of the *Generator annotation.
 TextRange getSequenceNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the 'sequenceName' element.
 boolean sequenceNameTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return whether the specified position touches the 'sequenceName' element.
 void setSequenceName(java.lang.String sequenceName)
          Corresponds to the 'sequenceName' element of the *Generator annotation.
 
Methods inherited from interface org.eclipse.jpt.jpa.core.resource.java.GeneratorAnnotation
getAllocationSize, getAllocationSizeTextRange, getInitialValue, getInitialValueTextRange, getName, getNameTextRange, setAllocationSize, setInitialValue, setName
 
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

SEQUENCE_NAME_PROPERTY

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

getSequenceName

java.lang.String getSequenceName()
Corresponds to the 'sequenceName' element of the *Generator annotation. Return null if the element does not exist in Java.


setSequenceName

void setSequenceName(java.lang.String sequenceName)
Corresponds to the 'sequenceName' element of the *Generator annotation. Set to null to remove the element.


getSequenceNameTextRange

TextRange getSequenceNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the 'sequenceName' element. If the element does not exist return the TextRange for the SequenceGenerator annotation.


sequenceNameTouches

boolean sequenceNameTouches(int pos,
                            org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return whether the specified position touches the 'sequenceName' element. Return false if the element does not exist.