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

All Superinterfaces:
JavaResourceNode, Model
All Known Subinterfaces:
NestableQueryHint

public interface QueryHintAnnotation
extends JavaResourceNode

Corresponds to the javax.persistence.QueryHint annotation 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 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.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

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. 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 QueryHint annotation. Setting to null will remove the name valuePair


getValue

java.lang.String getValue()
Corresponds to the value element of the QueryHint annotation. Returns null if the value valuePair 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 value valuePair


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 QueryHint annotation.


getValueTextRange

TextRange getValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the value element. If the value element does not exist return the TextRange for the QueryHint annotation.