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

All Superinterfaces:

Annotation, JavaResourceNode, Model

public interface XmlTypeAnnotation
extends Annotation

Corresponds to the JAXB annotation javax.xml.bind.annotation.XmlType 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	FACTORY_CLASS_PROPERTY
static java.lang.String	FACTORY_METHOD_PROPERTY
static java.lang.String	FULLY_QUALIFIED_FACTORY_CLASS_NAME_PROPERTY
static java.lang.String	NAME_PROPERTY
static java.lang.String	NAMESPACE_PROPERTY
static java.lang.String	PROP_ORDER_LIST

Method Summary

void	addProp(int index, java.lang.String prop) Corresponds to the 'propOrder' element of the XmlType annotation.
void	addProp(java.lang.String prop) Corresponds to the 'propOrder' element of the XmlType annotation.
java.lang.String	getFactoryClass() Corresponds to the 'factoryClass' element of the XmlType annotation.
TextRange	getFactoryClassTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'factoryClass' element.
java.lang.String	getFactoryMethod() Corresponds to the 'factoryMethod' element of the XmlType annotation.
TextRange	getFactoryMethodTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'factoryMethod' element.
java.lang.String	getFullyQualifiedFactoryClassName() Return the fully-qualified factory class name as resolved by the AST's bindings.
java.lang.String	getName() Corresponds to the 'name' element of the XmlType annotation.
java.lang.String	getNamespace() Corresponds to the 'namespace' element of the XmlType 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.
org.eclipse.jpt.common.utility.internal.iterables.ListIterable<java.lang.String>	getPropOrder() Corresponds to the 'propOrder' element of the XmlType annotation.
int	getPropOrderSize() Corresponds to the 'propOrder' element of the XmlType annotation.
void	moveProp(int targetIndex, int sourceIndex) Corresponds to the 'propOrder' element of the XmlType annotation.
boolean	namespaceTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'namespace' element.
boolean	nameTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'name' element.
void	removeProp(int index) Corresponds to the 'propOrder' element of the XmlType annotation.
void	removeProp(java.lang.String prop) Corresponds to the 'propOrder' element of the XmlType annotation.
void	setFactoryClass(java.lang.String factoryClass) Corresponds to the 'factoryClass' element of the XmlType annotation.
void	setFactoryMethod(java.lang.String factoryMethod) Corresponds to the 'factoryMethod' element of the XmlType annotation.
void	setName(java.lang.String name) Corresponds to the 'name' element of the XmlType annotation.
void	setNamespace(java.lang.String namespace) Corresponds to the 'namespace' element of the XmlType 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

FACTORY_CLASS_PROPERTY

static final java.lang.String FACTORY_CLASS_PROPERTY

See Also:

Constant Field Values

FULLY_QUALIFIED_FACTORY_CLASS_NAME_PROPERTY

static final java.lang.String FULLY_QUALIFIED_FACTORY_CLASS_NAME_PROPERTY

See Also:

Constant Field Values

FACTORY_METHOD_PROPERTY

static final java.lang.String FACTORY_METHOD_PROPERTY

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

PROP_ORDER_LIST

static final java.lang.String PROP_ORDER_LIST

See Also:

Constant Field Values

Method Detail

getFactoryClass

java.lang.String getFactoryClass()

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

     @XmlType(name="USAddressType", factoryClass=USAddressFactory.class)
 

will return "USAddressFactory"

setFactoryClass

void setFactoryClass(java.lang.String factoryClass)

Corresponds to the 'factoryClass' element of the XmlType annotation. Set to null to remove the element.

getFactoryClassTextRange

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

Return the TextRange for the 'factoryClass' element. If the element does not exist return the TextRange for the XmlType annotation.

getFullyQualifiedFactoryClassName

java.lang.String getFullyQualifiedFactoryClassName()

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

     @XmlType(name="USAddressType", factoryClass=USAddressFactory.class)
 

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

Returns:

getFactoryMethod

java.lang.String getFactoryMethod()

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

setFactoryMethod

void setFactoryMethod(java.lang.String factoryMethod)

Corresponds to the 'factoryMethod' element of the XmlType annotation. Set to null to remove the element.

getFactoryMethodTextRange

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

Return the TextRange for the 'factoryMethod' element. If the element does not exist return the TextRange for the XmlType annotation.

getName

java.lang.String getName()

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

nameTouches

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

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

getNamespace

java.lang.String getNamespace()

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

getPropOrder

org.eclipse.jpt.common.utility.internal.iterables.ListIterable<java.lang.String> getPropOrder()

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

getPropOrderSize

int getPropOrderSize()

Corresponds to the 'propOrder' element of the XmlType annotation.

addProp

void addProp(java.lang.String prop)

Corresponds to the 'propOrder' element of the XmlType annotation.

addProp

void addProp(int index,
             java.lang.String prop)

Corresponds to the 'propOrder' element of the XmlType annotation.

moveProp

void moveProp(int targetIndex,
              int sourceIndex)

Corresponds to the 'propOrder' element of the XmlType annotation.

removeProp

void removeProp(java.lang.String prop)

Corresponds to the 'propOrder' element of the XmlType annotation.

removeProp

void removeProp(int index)

Corresponds to the 'propOrder' element of the XmlType annotation.