org.eclipse.jpt.core.jpa2.resource.java
Interface NamedQuery2_0Annotation

All Superinterfaces:
Annotation, BaseNamedQueryAnnotation, JavaResourceNode, Model, NamedQueryAnnotation, NestableAnnotation, NestableNamedQueryAnnotation

public interface NamedQuery2_0Annotation
extends NamedQueryAnnotation

Corresponds to the JPA 2.0 annotation javax.persistence.NamedQuery 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.3
Version:
2.3

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.core.resource.java.JavaResourceNode
JavaResourceNode.Root
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.core.resource.java.JavaResourceNode
JavaResourceNode.Root
 
Field Summary
static java.lang.String LOCK_MODE_PROPERTY
           
 
Fields inherited from interface org.eclipse.jpt.core.resource.java.NamedQueryAnnotation
ANNOTATION_NAME
 
Fields inherited from interface org.eclipse.jpt.core.resource.java.BaseNamedQueryAnnotation
HINTS_LIST, NAME_PROPERTY, QUERY_PROPERTY
 
Method Summary
 LockModeType_2_0 getLockMode()
          Corresponds to the 'lockMode' element of the NamedQuery annotation.
 TextRange getLockModeTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the 'lockMode' element.
 boolean lockModeTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return whether the specified position touches the 'lockMode' element.
 void setLockMode(LockModeType_2_0 lockMode)
          Corresponds to the 'lockMode' element of the NamedQuery annotation.
 
Methods inherited from interface org.eclipse.jpt.core.resource.java.BaseNamedQueryAnnotation
addHint, getName, getNameTextRange, getQuery, getQueryTextRange, hintAt, hints, hintsSize, indexOfHint, moveHint, removeHint, setName, setQuery
 
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
 
Methods inherited from interface org.eclipse.jpt.core.resource.java.NestableAnnotation
initializeFrom, moveAnnotation
 
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

LOCK_MODE_PROPERTY

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

getLockMode

LockModeType_2_0 getLockMode()
Corresponds to the 'lockMode' element of the NamedQuery annotation. Return null if the element does not exist in Java.


setLockMode

void setLockMode(LockModeType_2_0 lockMode)
Corresponds to the 'lockMode' element of the NamedQuery annotation. Set to null to remove the element. If no other elements exist the NamedQuery annotation will be removed as well.


getLockModeTextRange

TextRange getLockModeTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the 'lockMode' element. If the element does not exist return the TextRange for the NamedQuery annotation.


lockModeTouches

boolean lockModeTouches(int pos,
                        org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return whether the specified position touches the 'lockMode' element. Return false if the element does not exist.