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

All Superinterfaces:
JavaResourceNode, Model

public interface BasicAnnotation
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 ANNOTATION_NAME
           
static java.lang.String FETCH_PROPERTY
           
static java.lang.String OPTIONAL_PROPERTY
           
 
Method Summary
 FetchType getFetch()
          Corresponds to the fetch element of the Basic annotation.
 TextRange getFetchTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the fetch element.
 java.lang.Boolean getOptional()
          Corresponds to the optional element of the Basic annotation.
 TextRange getOptionalTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the optional element.
 void setFetch(FetchType fetch)
          Corresponds to the fetch element of the Basic annotation.
 void setOptional(java.lang.Boolean optional)
          Corresponds to the optional element of the Basic 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

ANNOTATION_NAME

static final java.lang.String ANNOTATION_NAME
See Also:
Constant Field Values

FETCH_PROPERTY

static final java.lang.String FETCH_PROPERTY
See Also:
Constant Field Values

OPTIONAL_PROPERTY

static final java.lang.String OPTIONAL_PROPERTY
See Also:
Constant Field Values
Method Detail

getFetch

FetchType getFetch()
Corresponds to the fetch element of the Basic annotation. Returns null if the fetch element does not exist in java.


setFetch

void setFetch(FetchType fetch)
Corresponds to the fetch element of the Basic annotation. Set to null to remove the fetch element.


getOptional

java.lang.Boolean getOptional()
Corresponds to the optional element of the Basic annotation. Returns null if the optional element does not exist in java.


setOptional

void setOptional(java.lang.Boolean optional)
Corresponds to the optional element of the Basic annotation. Set to null to remove the optional element.


getFetchTextRange

TextRange getFetchTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the fetch element. If the fetch element does not exist return the TextRange for the Basic annotation.


getOptionalTextRange

TextRange getOptionalTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the optional element. If the optional element does not exist return the TextRange for the Basic annotation.