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

All Superinterfaces:

Annotation, JavaResourceNode, Model

All Known Subinterfaces:

SequenceGenerator2_0Annotation, SequenceGeneratorAnnotation, TableGeneratorAnnotation

public interface GeneratorAnnotation
extends Annotation

Common protocol among javax.persistence.SequenceGenerator javax.persistence.TableGenerator 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	ALLOCATION_SIZE_PROPERTY
static java.lang.String	INITIAL_VALUE_PROPERTY
static java.lang.String	NAME_PROPERTY

Method Summary

java.lang.Integer	getAllocationSize() Corresponds to the 'allocationSize' element of the *Generator annotation.
TextRange	getAllocationSizeTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'allocationSize' element.
java.lang.Integer	getInitialValue() Corresponds to the 'initialValue' element of the *Generator annotation.
TextRange	getInitialValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'initialValue' element.
java.lang.String	getName() Corresponds to the 'name' element of the *Generator annotation.
TextRange	getNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'name' element.
void	setAllocationSize(java.lang.Integer allocationSize) Corresponds to the 'allocationSize' element of the *Generator annotation.
void	setInitialValue(java.lang.Integer initialValue) Corresponds to the 'initialValue' element of the *Generator annotation.
void	setName(java.lang.String name) Corresponds to the 'name' element of the *Generator 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

NAME_PROPERTY

static final java.lang.String NAME_PROPERTY

See Also:

Constant Field Values

INITIAL_VALUE_PROPERTY

static final java.lang.String INITIAL_VALUE_PROPERTY

See Also:

Constant Field Values

ALLOCATION_SIZE_PROPERTY

static final java.lang.String ALLOCATION_SIZE_PROPERTY

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

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

setName

void setName(java.lang.String name)

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

getNameTextRange

TextRange getNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

Return the TextRange for the 'name' element. If the element does not exist return the TextRange for the *Generator annotation.

getInitialValue

java.lang.Integer getInitialValue()

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

setInitialValue

void setInitialValue(java.lang.Integer initialValue)

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

getInitialValueTextRange

TextRange getInitialValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

Return the TextRange for the 'initialValue' element. If the element does not exist return the TextRange for the *Generator annotation.

getAllocationSize

java.lang.Integer getAllocationSize()

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

setAllocationSize

void setAllocationSize(java.lang.Integer allocationSize)

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

getAllocationSizeTextRange

TextRange getAllocationSizeTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

Return the TextRange for the 'allocationSize' element. If the element does not exist return the TextRange for the *Generator annotation.