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

All Superinterfaces:

Annotation, JavaResourceNode, Model

public interface MapKeyAnnotation
extends Annotation

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

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

Method Summary

java.lang.String	getName() Corresponds to the 'name' element of the MapKey annotation.
TextRange	getNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'name' element.
boolean	nameTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'name' element.
void	setName(java.lang.String name) Corresponds to the 'name' element of the MapKey annotation.

Methods inherited from interface org.eclipse.jpt.core.resource.java.Annotation

getAnnotationName, getJdtAnnotation, newAnnotation, removeAnnotation

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

getFile, getJavaResourceCompilationUnit, getRoot, getTextRange, initialize, update

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

Method Detail

getName

java.lang.String getName()

Corresponds to the 'name' element of the MapKey annotation. Returns null if the element does not exist in Java.

setName

void setName(java.lang.String name)

Corresponds to the 'name' element of the MapKey annotation. Set to null to 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 MapKey annotation.

nameTouches

boolean nameTouches(int pos,
                    org.eclipse.jdt.core.dom.CompilationUnit astRoot)

Return whether the specified position touches the 'name' element. Return false if the element does not exist.