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

All Superinterfaces:

Annotation, DbGeneratorAnnotation, GeneratorAnnotation, JavaResourceModel, Model

All Known Subinterfaces:

SequenceGeneratorAnnotation2_0

public interface SequenceGeneratorAnnotation
extends DbGeneratorAnnotation

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

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	SEQUENCE_NAME_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.core.resource.java.DbGeneratorAnnotation

ALLOCATION_SIZE_PROPERTY, INITIAL_VALUE_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.core.resource.java.GeneratorAnnotation

NAME_PROPERTY

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

FILE_TRANSFORMER

Method Summary

String	getSequenceName() Corresponds to the 'sequenceName' element of the *Generator annotation.
TextRange	getSequenceNameTextRange() Return the TextRange for the 'sequenceName' element.
boolean	sequenceNameTouches(int pos) Return whether the specified position touches the 'sequenceName' element.
void	setSequenceName(String sequenceName) Corresponds to the 'sequenceName' element of the *Generator annotation.

Methods inherited from interface org.eclipse.jpt.jpa.core.resource.java.DbGeneratorAnnotation

getAllocationSize, getAllocationSizeTextRange, getInitialValue, getInitialValueTextRange, setAllocationSize, setInitialValue

Methods inherited from interface org.eclipse.jpt.jpa.core.resource.java.GeneratorAnnotation

getName, getNameTextRange, setName

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

SEQUENCE_NAME_PROPERTY

static final String SEQUENCE_NAME_PROPERTY

See Also:

Constant Field Values

Method Detail

getSequenceName

String getSequenceName()

Corresponds to the 'sequenceName' element of the *Generator annotation. Return null if the element does not exist in Java.

setSequenceName

void setSequenceName(String sequenceName)

Corresponds to the 'sequenceName' element of the *Generator annotation. Set to null to remove the element.

getSequenceNameTextRange

TextRange getSequenceNameTextRange()

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)

Return whether the specified position touches the 'sequenceName' element. Return false if the element does not exist.