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

All Superinterfaces:

Annotation, JavaResourceModel, Model, QNameAnnotation

public interface XmlElementDeclAnnotation
extends QNameAnnotation

Corresponds to the JAXB annotation javax.xml.bind.annotation.XmlElementDecl 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 String associated with "defaultValue" property changes.
static String	FULLY_QUALIFIED_SCOPE_CLASS_NAME_PROPERTY String associated with "fullyQualifiedScopeClassName" property changes.
static String	SCOPE_PROPERTY String associated with "scope" property changes.
static String	SUBSTITUTION_HEAD_NAME_PROPERTY String associated with "substitutionHeadName" property changes.
static String	SUBSTITUTION_HEAD_NAMESPACE_PROPERTY String associated with "substitutionHeadNamespace" property changes.

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 XmlElementDecl annotation.
TextRange	getDefaultValueTextRange() Return the TextRange for the 'defaultValue' element.
String	getFullyQualifiedScopeClassName() Return the fully-qualified scope class name as resolved by the AST's bindings.
String	getScope() Corresponds to the 'scope' element of the XmlElementDecl annotation.
TextRange	getScopeTextRange() Return the TextRange for the 'scope' element.
String	getSubstitutionHeadName() Corresponds to the 'substitutionHeadName' element of the XmlElementDecl annotation.
String	getSubstitutionHeadNamespace() Corresponds to the 'substitutionHeadNamespace' element of the XmlElementDecl annotation.
TextRange	getSubstitutionHeadNamespaceTextRange() Return the text range associated with the 'subtitutionHeadNamespace' element.
TextRange	getSubstitutionHeadNamespaceValidationTextRange() Return the validation text range associated with the 'subtitutionHeadNamespace' element.
TextRange	getSubstitutionHeadNameTextRange() Return the text range associated with the 'subtitutionHeadName' element.
TextRange	getSubstitutionHeadNameValidationTextRange() Return the validation text range associated with the 'subtitutionHeadName' element.
void	setDefaultValue(String defaultValue) Corresponds to the 'defaultValue' element of the XmlElementDecl annotation.
void	setScope(String scope) Corresponds to the 'scope' element of the XmlElementDecl annotation.
void	setSubstitutionHeadName(String substitutionHeadName) Corresponds to the 'substitutionHeadName' element of the XmlElementDecl annotation.
void	setSubstitutionHeadNamespace(String substitutionHeadNamespace) Corresponds to the 'substitutionHeadNamespace' element of the XmlElementDecl annotation.
boolean	substitutionHeadNamespaceTouches(int pos) Return whether the specified position touches the 'substitutionHeadNamespace' element.
boolean	substitutionHeadNameTouches(int pos) Return whether the specified position touches the 'substitutionHeadName' element.

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

Field Detail

SCOPE_PROPERTY

static final String SCOPE_PROPERTY

String associated with "scope" property changes.

See Also:

Constant Field Values

FULLY_QUALIFIED_SCOPE_CLASS_NAME_PROPERTY

static final String FULLY_QUALIFIED_SCOPE_CLASS_NAME_PROPERTY

String associated with "fullyQualifiedScopeClassName" property changes.

See Also:

Constant Field Values

SUBSTITUTION_HEAD_NAMESPACE_PROPERTY

static final String SUBSTITUTION_HEAD_NAMESPACE_PROPERTY

String associated with "substitutionHeadNamespace" property changes.

See Also:

Constant Field Values

SUBSTITUTION_HEAD_NAME_PROPERTY

static final String SUBSTITUTION_HEAD_NAME_PROPERTY

String associated with "substitutionHeadName" property changes.

See Also:

Constant Field Values

DEFAULT_VALUE_PROPERTY

static final String DEFAULT_VALUE_PROPERTY

String associated with "defaultValue" property changes.

See Also:

Constant Field Values

Method Detail

getScope

String getScope()

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

     @XmlElementDecl(type=XmlElementDecl.GLOBAL.class)
 

will return "XmlElementDecl.GLOBAL"

setScope

void setScope(String scope)

Corresponds to the 'scope' element of the XmlElementDecl annotation. Set to null to remove the element.

getScopeTextRange

TextRange getScopeTextRange()

Return the TextRange for the 'scope' element. If the element does not exist return the TextRange for the XmlElementDecl annotation.

getFullyQualifiedScopeClassName

String getFullyQualifiedScopeClassName()

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

     @XmlElementDecl(type=XmlElementDecl.GLOBAL.class)
 

will return "javax.xml.bind.annotation.XmlElementDecl.GLOBAL"

getSubstitutionHeadNamespace

String getSubstitutionHeadNamespace()

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

setSubstitutionHeadNamespace

void setSubstitutionHeadNamespace(String substitutionHeadNamespace)

Corresponds to the 'substitutionHeadNamespace' element of the XmlElementDecl annotation. Set to null to remove the element.

getSubstitutionHeadNamespaceTextRange

TextRange getSubstitutionHeadNamespaceTextRange()

Return the text range associated with the 'subtitutionHeadNamespace' element. Return null if the element is absent.

getSubstitutionHeadNamespaceValidationTextRange

TextRange getSubstitutionHeadNamespaceValidationTextRange()

Return the validation text range associated with the 'subtitutionHeadNamespace' element. Return the text range of this annotation if the element is absent.

substitutionHeadNamespaceTouches

boolean substitutionHeadNamespaceTouches(int pos)

Return whether the specified position touches the 'substitutionHeadNamespace' element. Return false if the element does not exist.

getSubstitutionHeadName

String getSubstitutionHeadName()

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

setSubstitutionHeadName

void setSubstitutionHeadName(String substitutionHeadName)

Corresponds to the 'substitutionHeadName' element of the XmlElementDecl annotation. Set to null to remove the element.

getSubstitutionHeadNameTextRange

TextRange getSubstitutionHeadNameTextRange()

Return the text range associated with the 'subtitutionHeadName' element. Return null if the element is absent.

getSubstitutionHeadNameValidationTextRange

TextRange getSubstitutionHeadNameValidationTextRange()

Return the validation text range associated with the 'subtitutionHeadName' element. Return the text range of this annotation if the element is absent.

substitutionHeadNameTouches

boolean substitutionHeadNameTouches(int pos)

Return whether the specified position touches the 'substitutionHeadName' element. Return false if the element does not exist.

getDefaultValue

String getDefaultValue()

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

setDefaultValue

void setDefaultValue(String defaultValue)

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