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

All Superinterfaces:

Annotation, JavaResourceNode, Model

All Known Subinterfaces:

BaseColumnAnnotation, BaseJoinColumnAnnotation, ColumnAnnotation, CompleteColumnAnnotation, CompleteJoinColumnAnnotation, DiscriminatorColumnAnnotation, EclipseLinkTenantDiscriminatorColumnAnnotation2_3, JoinColumnAnnotation, MapKeyColumn2_0Annotation, MapKeyJoinColumn2_0Annotation, OrderColumn2_0Annotation, PrimaryKeyJoinColumnAnnotation

public interface NamedColumnAnnotation
extends Annotation

Corresponds to the JPA annotations:

• javax.persistence.Column
• javax.persistence.MapKeyColumn
• javax.persistence.JoinColumn
• javax.persistence.MapKeyJoinColumn
• javax.persistence.DiscriminatorColumn
• javax.persistence.OrderColumn
• 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

Nested Class Summary

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

JavaResourceNode.FileTransformer, JavaResourceNode.Root

Field Summary

static String	COLUMN_DEFINITION_PROPERTY
static String	NAME_PROPERTY

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

FILE_TRANSFORMER

Method Summary

String	getColumnDefinition() Corresponds to the 'columnDefinition' element of the *Column annotation.
TextRange	getColumnDefinitionTextRange() Return the TextRange for the 'columnDefinition' element.
String	getName() Corresponds to the 'name' element of the *Column annotation.
TextRange	getNameTextRange() Return the TextRange for the 'name' element.
TextRange	getNameValidationTextRange()
boolean	isSpecified() Return whether the annotation exists in Java.
boolean	nameTouches(int pos) Return whether the specified position touches the 'name' element.
boolean	nameValidationTouches(int pos)
void	setColumnDefinition(String columnDefinition) Corresponds to the 'columnDefinition' element of the *Column annotation.
void	setName(String name) Corresponds to the 'name' element of the *Column annotation.

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.JavaResourceNode

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

NAME_PROPERTY

static final String NAME_PROPERTY

See Also:

Constant Field Values

COLUMN_DEFINITION_PROPERTY

static final String COLUMN_DEFINITION_PROPERTY

See Also:

Constant Field Values

Method Detail

isSpecified

boolean isSpecified()

Return whether the annotation exists in Java.

getName

String getName()

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

setName

void setName(String name)

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

getNameTextRange

TextRange getNameTextRange()

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)

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

getNameValidationTextRange

TextRange getNameValidationTextRange()

nameValidationTouches

boolean nameValidationTouches(int pos)

getColumnDefinition

String getColumnDefinition()

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

setColumnDefinition

void setColumnDefinition(String columnDefinition)

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

getColumnDefinitionTextRange

TextRange getColumnDefinitionTextRange()

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