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

All Superinterfaces:

Annotation, JavaResourceNode, Model

public interface XmlSchemaAnnotation
extends Annotation

Corresponds to the JAXB annotation javax.xml.bind.annotation.XmlSchema 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	ATTRIBUTE_FORM_DEFAULT_PROPERTY
static java.lang.String	ELEMENT_FORM_DEFAULT_PROPERTY
static java.lang.String	LOCATION_PROPERTY
static java.lang.String	NAMESPACE_PROPERTY
static java.lang.String	XMLNS_LIST

Method Summary

XmlNsAnnotation	addXmlns(int index) Corresponds to the 'xmlns' element of the XmlSchema annotation.
XmlNsForm	getAttributeFormDefault() Corresponds to the 'attributeFormDefault' element of the XmlSchema annotation.
TextRange	getAttributeFormDefaultTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'attributeFormDefault' element.
XmlNsForm	getElementFormDefault() Corresponds to the 'elementFormDefault' element of the XmlSchema annotation.
TextRange	getElementFormDefaultTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'elementFormDefault' element.
java.lang.String	getLocation() Corresponds to the 'location' element of the XmlSchema annotation.
TextRange	getLocationTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'location' element.
java.lang.String	getNamespace() Corresponds to the 'namespace' element of the XmlSchema annotation.
TextRange	getNamespaceTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'namespace' element.
org.eclipse.jpt.common.utility.internal.iterables.ListIterable<XmlNsAnnotation>	getXmlns() Corresponds to the 'xmlns' element of the XmlSchema annotation.
int	getXmlnsSize() Corresponds to the 'xmlns' element of the XmlSchema annotation.
void	moveXmlns(int targetIndex, int sourceIndex) Corresponds to the 'xmlns' element of the XmlSchema annotation.
boolean	namespaceTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'namespace' element.
void	removeXmlns(int index) Corresponds to the 'xmlns' element of the XmlSchema annotation.
void	setAttributeFormDefault(XmlNsForm attributeFormDefault) Corresponds to the 'attributeFormDefault' element of the XmlSchema annotation.
void	setElementFormDefault(XmlNsForm elementFormDefault) Corresponds to the 'elementFormDefault' element of the XmlSchema annotation.
void	setLocation(java.lang.String location) Corresponds to the 'location' element of the XmlSchema annotation.
void	setNamespace(java.lang.String namespace) Corresponds to the 'namespace' element of the XmlSchema annotation.
XmlNsAnnotation	xmlnsAt(int index) Corresponds to the 'xmlns' element of the XmlSchema annnotation.

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

ATTRIBUTE_FORM_DEFAULT_PROPERTY

static final java.lang.String ATTRIBUTE_FORM_DEFAULT_PROPERTY

See Also:

Constant Field Values

ELEMENT_FORM_DEFAULT_PROPERTY

static final java.lang.String ELEMENT_FORM_DEFAULT_PROPERTY

See Also:

Constant Field Values

LOCATION_PROPERTY

static final java.lang.String LOCATION_PROPERTY

See Also:

Constant Field Values

NAMESPACE_PROPERTY

static final java.lang.String NAMESPACE_PROPERTY

See Also:

Constant Field Values

XMLNS_LIST

static final java.lang.String XMLNS_LIST

See Also:

Constant Field Values

Method Detail

getAttributeFormDefault

XmlNsForm getAttributeFormDefault()

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

setAttributeFormDefault

void setAttributeFormDefault(XmlNsForm attributeFormDefault)

Corresponds to the 'attributeFormDefault' element of the XmlSchema annotation. Set to null to remove the element.

getAttributeFormDefaultTextRange

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

Return the TextRange for the 'attributeFormDefault' element. If the element does not exist return the TextRange for the XmlSchema annotation.

getElementFormDefault

XmlNsForm getElementFormDefault()

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

setElementFormDefault

void setElementFormDefault(XmlNsForm elementFormDefault)

Corresponds to the 'elementFormDefault' element of the XmlSchema annotation. Set to null to remove the element.

getElementFormDefaultTextRange

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

Return the TextRange for the 'elementFormDefault' element. If the element does not exist return the TextRange for the XmlSchema annotation.

getLocation

java.lang.String getLocation()

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

setLocation

void setLocation(java.lang.String location)

Corresponds to the 'location' element of the XmlSchema annotation. Set to null to remove the element.

getLocationTextRange

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

Return the TextRange for the 'location' element. If the element does not exist return the TextRange for the XmlSchema annotation.

getNamespace

java.lang.String getNamespace()

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

namespaceTouches

boolean namespaceTouches(int pos,
                         org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getXmlns

org.eclipse.jpt.common.utility.internal.iterables.ListIterable<XmlNsAnnotation> getXmlns()

Corresponds to the 'xmlns' element of the XmlSchema annotation. Return an empty iterator if the element does not exist in Java.

getXmlnsSize

int getXmlnsSize()

Corresponds to the 'xmlns' element of the XmlSchema annotation.

xmlnsAt

XmlNsAnnotation xmlnsAt(int index)

Corresponds to the 'xmlns' element of the XmlSchema annnotation.

addXmlns

XmlNsAnnotation addXmlns(int index)

Corresponds to the 'xmlns' element of the XmlSchema annotation.

moveXmlns

void moveXmlns(int targetIndex,
               int sourceIndex)

Corresponds to the 'xmlns' element of the XmlSchema annotation.

removeXmlns

void removeXmlns(int index)

Corresponds to the 'xmlns' element of the XmlSchema annotation.