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

All Superinterfaces:
JavaResourceNode, Model

public interface IdClassAnnotation
extends JavaResourceNode

This interface corresponds to the javax.persistence.IdClass annotation 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.


Field Summary
static java.lang.String ANNOTATION_NAME
           
static java.lang.String FULLY_QUALIFIED_CLASS_PROPERTY
           
static java.lang.String VALUE_PROPERTY
           
 
Method Summary
 java.lang.String getFullyQualifiedClass()
          Returns the qualified value name as it is resolved in the AST
 java.lang.String getValue()
          Corresponds to the value element of the IdClass 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 IdClass annotation.
 
Methods inherited from interface org.eclipse.jpt.core.resource.java.JavaResourceNode
getJpaCompilationUnit, getResourceModel, getTextRange, initialize, updateFromJava
 
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

VALUE_PROPERTY

static final java.lang.String VALUE_PROPERTY
See Also:
Constant Field Values

FULLY_QUALIFIED_CLASS_PROPERTY

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

getValue

java.lang.String getValue()
Corresponds to the value element of the IdClass annotation. Returns null if the value element does not exist in java. Returns the portion of the value preceding the .class.

@IdClass(value=Employee.class)

will return "Employee"


setValue

void setValue(java.lang.String value)
Corresponds to the value element of the IdClass annotation. Set to null to remove the value element. This will also remove the IdClass annotation itself.


getFullyQualifiedClass

java.lang.String getFullyQualifiedClass()
Returns the qualified value name as it is resolved in the AST

@IdClass(Employee.class)

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

Returns:

getValueTextRange

TextRange getValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the value element. If the value element does not exist return the TextRange for the IdClass annotation.