org.eclipse.jpt.jpa.core.jpa2.resource.java
Interface MapKeyClassAnnotation2_0

All Superinterfaces:

Annotation, JavaResourceModel, Model

public interface MapKeyClassAnnotation2_0
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

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceModel

JavaResourceModel.FileTransformer, JavaResourceModel.Root

Field Summary

static String	ANNOTATION_NAME
static String	VALUE_PROPERTY

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

FILE_TRANSFORMER

Method Summary

String	getFullyQualifiedClassName() Return the fully-qualified class name as resolved by the AST's bindings.
String	getValue() Corresponds to the 'value' element of the MapKeyClass annotation.
TextRange	getValueTextRange() Return the TextRange for the 'value' element.
void	setValue(String value) Corresponds to the 'value' element of the MapKeyClass 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.JavaResourceModel

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

VALUE_PROPERTY

static final String VALUE_PROPERTY

See Also:

Constant Field Values

Method Detail

getValue

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(String value)

Corresponds to the 'value' element of the MapKeyClass annotation. Set to null to remove the element.

getValueTextRange

TextRange getValueTextRange()

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

getFullyQualifiedClassName

String getFullyQualifiedClassName()

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

     @IdClass(Employee.class)
 

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