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

All Superinterfaces:

Annotation, JavaResourceModel, JaxbBasicSchemaComponentAnnotation, Model, NestableAnnotation, QNameAnnotation

public interface XmlElementAnnotation
extends JaxbBasicSchemaComponentAnnotation, NestableAnnotation

Corresponds to the JAXB annotation javax.xml.bind.annotation.XmlElement 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	DEFAULT_VALUE_PROPERTY
static String	FULLY_QUALIFIED_TYPE_NAME_PROPERTY
static String	NILLABLE_PROPERTY
static String	TYPE_PROPERTY

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

REQUIRED_PROPERTY

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	getDefaultValue() Corresponds to the 'defaultValue' element of the XmlElement annotation.
TextRange	getDefaultValueTextRange() Return the TextRange for the 'defaultValue' element.
String	getFullyQualifiedTypeName() Return the fully-qualified type name as resolved by the AST's bindings.
Boolean	getNillable() Corresponds to the 'nillable' element of the XmlElement annotation.
TextRange	getNillableTextRange() Return the TextRange for the 'nillable' element.
String	getType() Corresponds to the 'type' element of the XmlElement annotation.
TextRange	getTypeTextRange() Return the TextRange for the 'type' element.
void	setDefaultValue(String defaultValue) Corresponds to the 'defaultValue' element of the XmlElement annotation.
void	setNillable(Boolean nillable) Corresponds to the 'nillable' element of the XmlElement annotation.
void	setType(String type) Corresponds to the 'type' element of the XmlElement annotation.

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

getRequired, getRequiredTextRange, setRequired

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.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

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

moveAnnotation

Field Detail

DEFAULT_VALUE_PROPERTY

static final String DEFAULT_VALUE_PROPERTY

See Also:

Constant Field Values

NILLABLE_PROPERTY

static final String NILLABLE_PROPERTY

See Also:

Constant Field Values

TYPE_PROPERTY

static final String TYPE_PROPERTY

See Also:

Constant Field Values

FULLY_QUALIFIED_TYPE_NAME_PROPERTY

static final String FULLY_QUALIFIED_TYPE_NAME_PROPERTY

See Also:

Constant Field Values

Method Detail

getDefaultValue

String getDefaultValue()

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

setDefaultValue

void setDefaultValue(String defaultValue)

Corresponds to the 'defaultValue' element of the XmlElement annotation. Set to null to remove the element.

getDefaultValueTextRange

TextRange getDefaultValueTextRange()

Return the TextRange for the 'defaultValue' element. If the element does not exist return the TextRange for the XmlElement annotation.

getNillable

Boolean getNillable()

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

setNillable

void setNillable(Boolean nillable)

Corresponds to the 'nillable' element of the XmlElement annotation. Set to null to remove the element.

getNillableTextRange

TextRange getNillableTextRange()

Return the TextRange for the 'nillable' element. If the element does not exist return the TextRange for the XmlElement annotation.

getType

String getType()

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

     @XmlElement(type=Foo.class)
 

will return "Foo"

setType

void setType(String type)

Corresponds to the 'type' element of the XmlElement 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 XmlElement annotation.

getFullyQualifiedTypeName

String getFullyQualifiedTypeName()

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

     @XmlElement(type=Foo.class)
 

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

Returns: