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

All Superinterfaces:

Annotation, JavaResourceNode, Model

public interface MapKeyClass2_0Annotation
extends Annotation

Corresponds to the JPA 2.0 annotation javax.persistence.MapKeyClass

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

Field Summary

static java.lang.String	ANNOTATION_NAME
static java.lang.String	FULLY_QUALIFIED_CLASS_NAME_PROPERTY
static java.lang.String	VALUE_PROPERTY

Method Summary

java.lang.String	getFullyQualifiedClassName() Return the fully-qualified MapKeyClass name as resolved by the AST's bindings.
java.lang.String	getValue() Corresponds to the 'value' element of the MapKeyClass annotation.
TextRange	getValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'value' element.
void	setValue(java.lang.String value) Corresponds to the 'value' element of the MapKeyClass annotation.

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

ANNOTATION_NAME

static final java.lang.String ANNOTATION_NAME

See Also:

Constant Field Values

VALUE_PROPERTY

static final java.lang.String VALUE_PROPERTY

See Also:

Constant Field Values

FULLY_QUALIFIED_CLASS_NAME_PROPERTY

static final java.lang.String FULLY_QUALIFIED_CLASS_NAME_PROPERTY

See Also:

Constant Field Values

Method Detail

getValue

java.lang.String getValue()

Corresponds to the 'value' element of the MapKeyClass annotation. Return null if the element does not exist in Java. Return the portion of the value preceding ".class".

     @MapKeyClass(value=Employee.class)
 

will return "Employee"

setValue

void setValue(java.lang.String value)

Corresponds to the 'value' element of the MapKeyClass annotation. Set to null to remove the element. This will also remove the MapKeyClass annotation itself.

getValueTextRange

TextRange getValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

Return the TextRange for the 'value' element. If the element does not exist return the TextRange for the IdClass annotation.

getFullyQualifiedClassName

java.lang.String getFullyQualifiedClassName()

Return the fully-qualified MapKeyClass name as resolved by the AST's bindings.

     @IdClass(Employee.class)
 

will return "model.Employee" if there is an import for model.Employee.