org.eclipse.jpt.jpa.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.

Since:

2.0

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

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

FILE_TRANSFORMER

Method Summary

String	getName() Corresponds to the 'name' element of the MapKey annotation.
TextRange	getNameTextRange() Return the TextRange for the 'name' element.
boolean	nameTouches(int pos) Return whether the specified position touches the 'name' element.
void	setName(String name) Corresponds to the 'name' element of the MapKey annotation.

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

ANNOTATION_NAME

static final String ANNOTATION_NAME

See Also:

Constant Field Values

NAME_PROPERTY

static final String NAME_PROPERTY

See Also:

Constant Field Values

Method Detail

getName

String getName()

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

setName

void setName(String name)

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

getNameTextRange

TextRange getNameTextRange()

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)

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