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

All Superinterfaces:
JavaResourceNode, Model
All Known Subinterfaces:
BaseColumnAnnotation, ColumnAnnotation, DiscriminatorColumnAnnotation, JoinColumnAnnotation, NestableJoinColumn, NestablePrimaryKeyJoinColumn, PrimaryKeyJoinColumnAnnotation

public interface NamedColumnAnnotation
extends JavaResourceNode

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.


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 nameTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return whether the specified postition 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.JavaResourceNode
getJpaCompilationUnit, getResourceModel, getTextRange, initialize, updateFromJava
 
Methods inherited from interface org.eclipse.jpt.utility.model.Model
addCollectionChangeListener, addCollectionChangeListener, addListChangeListener, addListChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, addTreeChangeListener, removeCollectionChangeListener, removeCollectionChangeListener, removeListChangeListener, removeListChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener, 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

getName

java.lang.String getName()
Corresponds to the name element of the *Column annotation. Returns null if the name valuePair does not exist in the annotation


setName

void setName(java.lang.String name)
Corresponds to the name element of the *Column annotation. Set to null to remove the name valuePair from the annotation


getColumnDefinition

java.lang.String getColumnDefinition()
Corresponds to the columnDefinition element of the *Column annotation. Returns null if the columnDefinition valuePair does not exist in the annotation


setColumnDefinition

void setColumnDefinition(java.lang.String columnDefinition)
Corresponds to the columnDefinition element of the *Column annotation. Set to null to remove the columnDefinition valuePair from the annotation


getNameTextRange

TextRange getNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the name element. If the name element does not exist return the TextRange for the *Column annotation.


getColumnDefinitionTextRange

TextRange getColumnDefinitionTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the columnDefinition element. If the columnDefinition 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 postition touches the name element. Return false if the name element does not exist.