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

All Superinterfaces:

Annotation, GeneratorAnnotation, JavaResourceModel, Model

All Known Subinterfaces:

SequenceGeneratorAnnotation, SequenceGeneratorAnnotation2_0, TableGeneratorAnnotation

public interface DatabaseGeneratorAnnotation
extends GeneratorAnnotation

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:

3.3

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	ALLOCATION_SIZE_PROPERTY
static String	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

Integer	getAllocationSize() Corresponds to the 'allocationSize' element of the *Generator annotation.
TextRange	getAllocationSizeTextRange() Return the TextRange for the 'allocationSize' element.
Integer	getInitialValue() Corresponds to the 'initialValue' element of the *Generator annotation.
TextRange	getInitialValueTextRange() Return the TextRange for the 'initialValue' element.
void	setAllocationSize(Integer allocationSize) Corresponds to the 'allocationSize' element of the *Generator annotation.
void	setInitialValue(Integer initialValue) Corresponds to the 'initialValue' element of the *Generator annotation.

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

INITIAL_VALUE_PROPERTY

static final String INITIAL_VALUE_PROPERTY

See Also:

Constant Field Values

ALLOCATION_SIZE_PROPERTY

static final String ALLOCATION_SIZE_PROPERTY

See Also:

Constant Field Values

Method Detail

getInitialValue

Integer getInitialValue()

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

setInitialValue

void setInitialValue(Integer initialValue)

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

getInitialValueTextRange

TextRange getInitialValueTextRange()

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

getAllocationSize

Integer getAllocationSize()

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

setAllocationSize

void setAllocationSize(Integer allocationSize)

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

getAllocationSizeTextRange

TextRange getAllocationSizeTextRange()

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