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

All Superinterfaces:

Annotation, JavaResourceNode, Model

public interface BasicAnnotation
extends Annotation

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

JavaResourceNode.Root

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.jpa.core.resource.java.Annotation

getAnnotationName, getAstAnnotation, isUnset, newAnnotation, removeAnnotation, restoreFrom, storeOn

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

getFile, getJavaResourceCompilationUnit, getParent, getRoot, getTextRange, initialize, synchronizeWith

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

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. Return null if the 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 element.

getFetchTextRange

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

Return the TextRange for the 'fetch' element. If the element does not exist return the TextRange for the Basic annotation.

getOptional

java.lang.Boolean getOptional()

Corresponds to the 'optional' element of the Basic annotation. Return null if the 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 element.

getOptionalTextRange

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

Return the TextRange for the 'optional' element. If the element does not exist return the TextRange for the Basic annotation.