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

All Superinterfaces:

Annotation, JavaResourceNode, Model

All Known Subinterfaces:

NestableQueryHintAnnotation

public interface QueryHintAnnotation
extends Annotation

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

JavaResourceNode.Root

Field Summary

static java.lang.String	ANNOTATION_NAME
static java.lang.String	NAME_PROPERTY
static java.lang.String	VALUE_PROPERTY

Method Summary

java.lang.String	getName() Corresponds to the 'name' element of the QueryHint annotation.
TextRange	getNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'name' element.
java.lang.String	getValue() Corresponds to the 'value' element of the QueryHint annotation.
TextRange	getValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'value' element.
void	setName(java.lang.String name) Corresponds to the 'name' element of the QueryHint annotation.
void	setValue(java.lang.String value) Corresponds to the 'value' element of the QueryHint 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

ANNOTATION_NAME

static final java.lang.String ANNOTATION_NAME

See Also:

Constant Field Values

NAME_PROPERTY

static final java.lang.String NAME_PROPERTY

See Also:

Constant Field Values

VALUE_PROPERTY

static final java.lang.String VALUE_PROPERTY

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

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

setName

void setName(java.lang.String name)

Corresponds to the 'name' element of the QueryHint annotation. Setting to null will 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 QueryHint annotation.

getValue

java.lang.String getValue()

Corresponds to the 'value' element of the QueryHint annotation. Return null if the element does not exist in the annotation

setValue

void setValue(java.lang.String value)

Corresponds to the 'value' element of the QueryHint annotation. Setting to null will remove the element.

getValueTextRange

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

Return the TextRange for the 'value' element. If the element does not exist return the TextRange for the QueryHint annotation.