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

All Superinterfaces:

Annotation, JavaResourceNode, Model, NestableAnnotation

All Known Subinterfaces:

NamedNativeQueryAnnotation, NamedQuery2_0Annotation, NamedQueryAnnotation

public interface QueryAnnotation
extends NestableAnnotation

Common protocol among:

• javax.persistence.NamedQuery
• javax.persistence.NamedNativeQuery

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

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	HINTS_LIST
static String	NAME_PROPERTY

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

FILE_TRANSFORMER

Method Summary

QueryHintAnnotation	addHint(int index) Corresponds to the 'hints' element of the *Query annotation.
org.eclipse.jpt.common.utility.iterable.ListIterable<QueryHintAnnotation>	getHints() Corresponds to the 'hints' element of the *Query annotation.
int	getHintsSize() Corresponds to the 'hints' element of the *Query annotation.
String	getName() Corresponds to the 'name' element of the *Query annotation.
TextRange	getNameTextRange() Return the TextRange for the 'name' element.
QueryHintAnnotation	hintAt(int index) Corresponds to the 'hints' element of the *Query annotation.
void	moveHint(int targetIndex, int sourceIndex) Corresponds to the 'hints' element of the *Query annotation.
void	removeHint(int index) Corresponds to the 'hints' element of the *Query annotation.
void	setName(String name) Corresponds to the 'name' element of the *Query annotation.

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.NestableAnnotation

moveAnnotation

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

HINTS_LIST

static final String HINTS_LIST

See Also:

Constant Field Values

Method Detail

getName

String getName()

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

setName

void setName(String name)

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

getNameTextRange

TextRange getNameTextRange()

Return the TextRange for the 'name' element. If element does not exist return the TextRange for the *Query annotation.

getHints

org.eclipse.jpt.common.utility.iterable.ListIterable<QueryHintAnnotation> getHints()

Corresponds to the 'hints' element of the *Query annotation. Return an empty iterator if the element does not exist in Java.

getHintsSize

int getHintsSize()

Corresponds to the 'hints' element of the *Query annotation.

hintAt

QueryHintAnnotation hintAt(int index)

Corresponds to the 'hints' element of the *Query annotation.

addHint

QueryHintAnnotation addHint(int index)

Corresponds to the 'hints' element of the *Query annotation.

moveHint

void moveHint(int targetIndex,
              int sourceIndex)

Corresponds to the 'hints' element of the *Query annotation.

removeHint

void removeHint(int index)

Corresponds to the 'hints' element of the *Query annotation.