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

All Superinterfaces:

Annotation, JavaResourceNode, Model

public interface XmlElementDeclAnnotation
extends Annotation

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

Version:

3.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.jaxb.core.resource.java.JavaResourceNode

JavaResourceNode.Root

Field Summary

static java.lang.String	ANNOTATION_NAME
static java.lang.String	DEFAULT_VALUE_PROPERTY
static java.lang.String	FULLY_QUALIFIED_SCOPE_CLASS_NAME_PROPERTY
static java.lang.String	NAME_PROPERTY
static java.lang.String	NAMESPACE_PROPERTY
static java.lang.String	SCOPE_PROPERTY
static java.lang.String	SUBSTITUTION_HEAD_NAME_PROPERTY
static java.lang.String	SUBSTITUTION_HEAD_NAMESPACE_PROPERTY

Method Summary

java.lang.String	getDefaultValue() Corresponds to the 'defaultValue' element of the XmlElementDecl annotation.
TextRange	getDefaultValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'defaultValue' element.
java.lang.String	getFullyQualifiedScopeClassName() Return the fully-qualified scope class name as resolved by the AST's bindings.
java.lang.String	getName() Corresponds to the 'name' element of the XmlElementDecl annotation.
java.lang.String	getNamespace() Corresponds to the 'namespace' element of the XmlElementDecl annotation.
TextRange	getNamespaceTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'namespace' element.
TextRange	getNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'name' element.
java.lang.String	getScope() Corresponds to the 'scope' element of the XmlElementDecl annotation.
TextRange	getScopeTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'scope' element.
java.lang.String	getSubstitutionHeadName() Corresponds to the 'substitutionHeadName' element of the XmlElementDecl annotation.
java.lang.String	getSubstitutionHeadNamespace() Corresponds to the 'substitutionHeadNamespace' element of the XmlElementDecl annotation.
TextRange	getSubstitutionHeadNamespaceTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'substitutionHeadNamespace' element.
TextRange	getSubstitutionHeadNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'substitutionHeadName' element.
void	setDefaultValue(java.lang.String defaultValue) Corresponds to the 'defaultValue' element of the XmlElementDecl annotation.
void	setName(java.lang.String name) Corresponds to the 'name' element of the XmlElementDecl annotation.
void	setNamespace(java.lang.String namespace) Corresponds to the 'namespace' element of the XmlElementDecl annotation.
void	setScope(java.lang.String scope) Corresponds to the 'scope' element of the XmlElementDecl annotation.
void	setSubstitutionHeadName(java.lang.String substitutionHeadName) Corresponds to the 'substitutionHeadName' element of the XmlElementDecl annotation.
void	setSubstitutionHeadNamespace(java.lang.String substitutionHeadNamespace) Corresponds to the 'substitutionHeadNamespace' element of the XmlElementDecl annotation.

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

getAnnotationName, getAstAnnotation, newAnnotation, removeAnnotation

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

getFile, getJavaResourceCompilationUnit, getRoot, getTextRange, initialize, synchronizeWith

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener

Field Detail

ANNOTATION_NAME

static final java.lang.String ANNOTATION_NAME

See Also:

Constant Field Values

NAME_PROPERTY

static final java.lang.String NAME_PROPERTY

See Also:

Constant Field Values

NAMESPACE_PROPERTY

static final java.lang.String NAMESPACE_PROPERTY

See Also:

Constant Field Values

DEFAULT_VALUE_PROPERTY

static final java.lang.String DEFAULT_VALUE_PROPERTY

See Also:

Constant Field Values

SCOPE_PROPERTY

static final java.lang.String SCOPE_PROPERTY

See Also:

Constant Field Values

FULLY_QUALIFIED_SCOPE_CLASS_NAME_PROPERTY

static final java.lang.String FULLY_QUALIFIED_SCOPE_CLASS_NAME_PROPERTY

See Also:

Constant Field Values

SUBSTITUTION_HEAD_NAME_PROPERTY

static final java.lang.String SUBSTITUTION_HEAD_NAME_PROPERTY

See Also:

Constant Field Values

SUBSTITUTION_HEAD_NAMESPACE_PROPERTY

static final java.lang.String SUBSTITUTION_HEAD_NAMESPACE_PROPERTY

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

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

setName

void setName(java.lang.String name)

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

getNameTextRange

TextRange getNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getNamespace

java.lang.String getNamespace()

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

setNamespace

void setNamespace(java.lang.String namespace)

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

getNamespaceTextRange

TextRange getNamespaceTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getDefaultValue

java.lang.String getDefaultValue()

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

setDefaultValue

void setDefaultValue(java.lang.String defaultValue)

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

getDefaultValueTextRange

TextRange getDefaultValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getScope

java.lang.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(java.lang.String scope)

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

getScopeTextRange

TextRange getScopeTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getFullyQualifiedScopeClassName

java.lang.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"

getSubstitutionHeadName

java.lang.String getSubstitutionHeadName()

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

setSubstitutionHeadName

void setSubstitutionHeadName(java.lang.String substitutionHeadName)

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

getSubstitutionHeadNameTextRange

TextRange getSubstitutionHeadNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getSubstitutionHeadNamespace

java.lang.String getSubstitutionHeadNamespace()

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

setSubstitutionHeadNamespace

void setSubstitutionHeadNamespace(java.lang.String substitutionHeadNamespace)

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

getSubstitutionHeadNamespaceTextRange

TextRange getSubstitutionHeadNamespaceTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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