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

All Superinterfaces:

Annotation, JavaResourceNode, Model

All Known Subinterfaces:

BaseColumnAnnotation, BaseJoinColumnAnnotation, ColumnAnnotation, DiscriminatorColumnAnnotation, JoinColumnAnnotation, MapKeyColumn2_0Annotation, MapKeyJoinColumn2_0Annotation, NestableColumnAnnotation, NestableJoinColumnAnnotation, NestableMapKeyJoinColumnAnnotation, NestablePrimaryKeyJoinColumnAnnotation, OrderColumn2_0Annotation, PrimaryKeyJoinColumnAnnotation

public interface NamedColumnAnnotation
extends Annotation

Common protocol among javax.persistence.Column javax.persistence.JoinColumn javax.persistence.DiscriminatorColumn javax.persistence.PrimaryKeyJoinColumn. 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.3

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.core.resource.java.JavaResourceNode

JavaResourceNode.Root

Field Summary

static java.lang.String	COLUMN_DEFINITION_PROPERTY
static java.lang.String	NAME_PROPERTY

Method Summary

java.lang.String	getColumnDefinition() Corresponds to the 'columnDefinition' element of the *Column annotation.
TextRange	getColumnDefinitionTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'columnDefinition' element.
java.lang.String	getName() Corresponds to the 'name' element of the *Column annotation.
TextRange	getNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'name' element.
boolean	isSpecified() Return true if the annotation exists in Java, false if it does not.
boolean	nameTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'name' element.
void	setColumnDefinition(java.lang.String columnDefinition) Corresponds to the 'columnDefinition' element of the *Column annotation.
void	setName(java.lang.String name) Corresponds to the 'name' element of the *Column annotation.

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

NAME_PROPERTY

static final java.lang.String NAME_PROPERTY

See Also:

Constant Field Values

COLUMN_DEFINITION_PROPERTY

static final java.lang.String COLUMN_DEFINITION_PROPERTY

See Also:

Constant Field Values

Method Detail

isSpecified

boolean isSpecified()

Return true if the annotation exists in Java, false if it does not.

getName

java.lang.String getName()

Corresponds to the 'name' element of the *Column 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 *Column 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 *Column annotation.

nameTouches

boolean nameTouches(int pos,
                    org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getColumnDefinition

java.lang.String getColumnDefinition()

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

setColumnDefinition

void setColumnDefinition(java.lang.String columnDefinition)

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

getColumnDefinitionTextRange

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

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