org.eclipse.jpt.core.resource.java
Interface ColumnAnnotation

All Superinterfaces:

Annotation, BaseColumnAnnotation, JavaResourceNode, Model, NamedColumnAnnotation

All Known Subinterfaces:

MapKeyColumn2_0Annotation, NestableColumnAnnotation

public interface ColumnAnnotation
extends BaseColumnAnnotation

Corresponds to the JPA annotation javax.persistence.Column 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.core.resource.java.JavaResourceNode

JavaResourceNode.Root

Field Summary

static java.lang.String	ANNOTATION_NAME
static java.lang.String	LENGTH_PROPERTY
static java.lang.String	PRECISION_PROPERTY
static java.lang.String	SCALE_PROPERTY

Fields inherited from interface org.eclipse.jpt.core.resource.java.BaseColumnAnnotation

INSERTABLE_PROPERTY, NULLABLE_PROPERTY, TABLE_PROPERTY, UNIQUE_PROPERTY, UPDATABLE_PROPERTY

Fields inherited from interface org.eclipse.jpt.core.resource.java.NamedColumnAnnotation

COLUMN_DEFINITION_PROPERTY, NAME_PROPERTY

Method Summary

java.lang.Integer	getLength() Corresponds to the 'length' element of the Column annotation.
TextRange	getLengthTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'length' element.
java.lang.Integer	getPrecision() Corresponds to the 'precision' element of the Column annotation.
TextRange	getPrecisionTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'precision' element.
java.lang.Integer	getScale() Corresponds to the 'scale' element of the Column annotation.
TextRange	getScaleTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'scale' element.
void	setLength(java.lang.Integer length) Corresponds to the 'length' element of the Column annotation.
void	setPrecision(java.lang.Integer precision) Corresponds to the 'precision' element of the Column annotation.
void	setScale(java.lang.Integer scale) Corresponds to the 'scale' element of the Column annotation.

Methods inherited from interface org.eclipse.jpt.core.resource.java.BaseColumnAnnotation

getInsertable, getInsertableTextRange, getNullable, getNullableTextRange, getTable, getTableTextRange, getUnique, getUniqueTextRange, getUpdatable, getUpdatableTextRange, setInsertable, setNullable, setTable, setUnique, setUpdatable, tableTouches

Methods inherited from interface org.eclipse.jpt.core.resource.java.NamedColumnAnnotation

getColumnDefinition, getColumnDefinitionTextRange, getName, getNameTextRange, isSpecified, nameTouches, setColumnDefinition, setName

Methods inherited from interface org.eclipse.jpt.core.resource.java.Annotation

getAnnotationName, getAstAnnotation, newAnnotation, removeAnnotation

Methods inherited from interface org.eclipse.jpt.core.resource.java.JavaResourceNode

getFile, getJavaResourceCompilationUnit, getRoot, getTextRange, initialize, synchronizeWith

Methods inherited from interface org.eclipse.jpt.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

LENGTH_PROPERTY

static final java.lang.String LENGTH_PROPERTY

See Also:

Constant Field Values

PRECISION_PROPERTY

static final java.lang.String PRECISION_PROPERTY

See Also:

Constant Field Values

SCALE_PROPERTY

static final java.lang.String SCALE_PROPERTY

See Also:

Constant Field Values

Method Detail

getLength

java.lang.Integer getLength()

Corresponds to the 'length' element of the Column annotation. Return null if the element does not exist in Java.

setLength

void setLength(java.lang.Integer length)

Corresponds to the 'length' element of the Column annotation. Set to null to remove the element.

getLengthTextRange

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

Return the TextRange for the 'length' element. If element does not exist return the TextRange for the Column annotation.

getPrecision

java.lang.Integer getPrecision()

Corresponds to the 'precision' element of the Column annotation. Return null if the element does not exist in Java.

setPrecision

void setPrecision(java.lang.Integer precision)

Corresponds to the 'precision' element of the Column annotation. Set to null to remove the element.

getPrecisionTextRange

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

Return the TextRange for the 'precision' element. If element does not exist return the TextRange for the Column annotation.

getScale

java.lang.Integer getScale()

Corresponds to the 'scale' element of the Column annotation. Return null if the element does not exist in Java.

setScale

void setScale(java.lang.Integer scale)

Corresponds to the 'scale' element of the Column annotation. Set to null to remove the element.

getScaleTextRange

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

Return the TextRange for the 'scale' element. If element does not exist return the TextRange for the Column annotation.