org.eclipse.jpt.jaxb.core.resource.java
Interface XmlElementRefAnnotation

All Superinterfaces:

Annotation, JavaResourceModel, Model, NestableAnnotation, QNameAnnotation

public interface XmlElementRefAnnotation
extends QNameAnnotation, NestableAnnotation

Corresponds to the JAXB annotation javax.xml.bind.annotation.XmlElementRef 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:

3.0

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	FULLY_QUALIFIED_TYPE_NAME_PROPERTY String associated with changes to the 'fullyQualifiedName' property of this annotation.
static String	REQUIRED_PROPERTY String associated with changes to the 'required' property of this annotation.
static String	TYPE_PROPERTY String associated with changes to the 'type' property of this annotation.

Fields inherited from interface org.eclipse.jpt.jaxb.core.resource.java.QNameAnnotation

NAME_PROPERTY, NAMESPACE_PROPERTY

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

FILE_TRANSFORMER

Method Summary

String	getFullyQualifiedTypeName() Return the fully-qualified type name as resolved by the AST's bindings.
Boolean	getRequired() Corresponds to the 'required' element of this annotation.
TextRange	getRequiredTextRange() Return the TextRange for the 'required' element.
String	getType() Corresponds to the 'type' element of this annotation.
TextRange	getTypeTextRange() Return the TextRange for the 'type' element.
void	setRequired(Boolean required) Corresponds to the 'required' element of this annotation.
void	setType(String type) Corresponds to the 'type' element of this annotation.

Methods inherited from interface org.eclipse.jpt.jaxb.core.resource.java.QNameAnnotation

getName, getNamespace, getNamespaceTextRange, getNamespaceValidationTextRange, getNameTextRange, getNameValidationTextRange, namespaceTouches, nameTouches, setName, setNamespace

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.NestableAnnotation

moveAnnotation

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

REQUIRED_PROPERTY

static final String REQUIRED_PROPERTY

String associated with changes to the 'required' property of this annotation.

See Also:

Constant Field Values

TYPE_PROPERTY

static final String TYPE_PROPERTY

String associated with changes to the 'type' property of this annotation.

See Also:

Constant Field Values

FULLY_QUALIFIED_TYPE_NAME_PROPERTY

static final String FULLY_QUALIFIED_TYPE_NAME_PROPERTY

String associated with changes to the 'fullyQualifiedName' property of this annotation.

See Also:

Constant Field Values

Method Detail

getRequired

Boolean getRequired()

Corresponds to the 'required' element of this annotation. Return null if the element does not exist in Java.

setRequired

void setRequired(Boolean required)

Corresponds to the 'required' element of this annotation. Set to null to remove the element.

getRequiredTextRange

TextRange getRequiredTextRange()

Return the TextRange for the 'required' element. If the element does not exist return the TextRange for the annotation itself.

getType

String getType()

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

     @XmlElementRef(type=Foo.class)
 

will return "Foo"

setType

void setType(String type)

Corresponds to the 'type' element of this annotation. Set to null to remove the element.

getTypeTextRange

TextRange getTypeTextRange()

Return the TextRange for the 'type' element. If the element does not exist return the TextRange for the annotation itself.

getFullyQualifiedTypeName

String getFullyQualifiedTypeName()

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

     @XmlElementRef(type=Foo.class)
 

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

Returns: