org.eclipse.jpt.jaxb.core.context
Interface JaxbPersistentType

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JavaContextNode, JaxbContextNode, JaxbNode, JaxbType, Model

All Known Subinterfaces:

JaxbPersistentClass, JaxbPersistentEnum

public interface JaxbPersistentType
extends JaxbType

Represents a JAXB persistent type (class or enum). (A class with either an explicit or implicit @XmlType annotation)

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

JaxbType.Kind

Field Summary

static java.lang.String	FACTORY_CLASS_PROPERTY
static java.lang.String	FACTORY_METHOD_PROPERTY
static java.lang.String	PROP_ORDER_LIST
static java.lang.String	ROOT_ELEMENT
static java.lang.String	SPECIFIED_NAMESPACE_PROPERTY String constant associated with changes to the specified xml type namespace
static java.lang.String	SPECIFIED_XML_TYPE_NAME_PROPERTY String constant associated with changes to the specified xml type name

Method Summary

void	addProp(int index, java.lang.String prop)
java.lang.String	getDefaultNamespace() Return the default namespace
java.lang.String	getDefaultXmlTypeName() Return the default xml type name
java.lang.String	getFactoryClass() factory class corresponds to the XmlType annotation factoryClass element
java.lang.String	getFactoryMethod() factory method corresponds to the XmlType annotation factoryMethod element
java.lang.String	getNamespace() Return the specified xml type namespace or the default namespace if it is not specified
org.eclipse.jpt.common.utility.internal.iterables.ListIterable<java.lang.String>	getPropOrder() propOrder corresponds to the XmlType annotation propOrder element
int	getPropOrderSize()
XmlRootElement	getRootElement() Return the root element or null if it is not a root element.
java.lang.String	getSpecifiedNamespace() Return the specified xml type namespace or null if it is not specified
java.lang.String	getSpecifiedXmlTypeName() Return the specified xml type name or null if it is not specified
java.lang.String	getXmlTypeName() Return the specified xml type name or the default type name if it is not specified
XsdTypeDefinition	getXsdTypeDefinition()
boolean	isRootElement() Return whether this class is a root element (has the XmlRootElement annotation)
void	moveProp(int targetIndex, int sourceIndex)
void	removeProp(int index)
void	removeProp(java.lang.String prop)
void	setFactoryClass(java.lang.String factoryClass)
void	setFactoryMethod(java.lang.String factoryMethod)
XmlRootElement	setRootElement(java.lang.String name) Set the root element name, this will add the XmlRootElement annotation and set its name to the specified name.
void	setSpecifiedNamespace(java.lang.String namespace) Set the xml type namespace, null to unspecify (use the default)
void	setSpecifiedXmlTypeName(java.lang.String xmlTypeName) Set the xml type name, null to unspecify (use the default)

Methods inherited from interface org.eclipse.jpt.jaxb.core.context.JaxbType

getDirectlyReferencedTypeNames, getFullyQualifiedName, getJavaResourceType, getJaxbPackage, getKind, getPackageName, getSimpleName, getTypeQualifiedName, validate

Methods inherited from interface org.eclipse.jpt.jaxb.core.context.java.JavaContextNode

getJavaCompletionProposals, getValidationTextRange, validate

Methods inherited from interface org.eclipse.jpt.jaxb.core.context.JaxbContextNode

getContextRoot, getResourceType, synchronizeWithResourceModel, update

Methods inherited from interface org.eclipse.jpt.jaxb.core.JaxbNode

getJaxbProject, getParent, stateChanged

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

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

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.IResourcePart

getResource

Field Detail

FACTORY_CLASS_PROPERTY

static final java.lang.String FACTORY_CLASS_PROPERTY

See Also:

Constant Field Values

FACTORY_METHOD_PROPERTY

static final java.lang.String FACTORY_METHOD_PROPERTY

See Also:

Constant Field Values

SPECIFIED_XML_TYPE_NAME_PROPERTY

static final java.lang.String SPECIFIED_XML_TYPE_NAME_PROPERTY

String constant associated with changes to the specified xml type name

See Also:

Constant Field Values

SPECIFIED_NAMESPACE_PROPERTY

static final java.lang.String SPECIFIED_NAMESPACE_PROPERTY

String constant associated with changes to the specified xml type namespace

See Also:

Constant Field Values

PROP_ORDER_LIST

static final java.lang.String PROP_ORDER_LIST

See Also:

Constant Field Values

ROOT_ELEMENT

static final java.lang.String ROOT_ELEMENT

See Also:

Constant Field Values

Method Detail

getFactoryClass

java.lang.String getFactoryClass()

factory class corresponds to the XmlType annotation factoryClass element

setFactoryClass

void setFactoryClass(java.lang.String factoryClass)

getFactoryMethod

java.lang.String getFactoryMethod()

factory method corresponds to the XmlType annotation factoryMethod element

setFactoryMethod

void setFactoryMethod(java.lang.String factoryMethod)

getXmlTypeName

java.lang.String getXmlTypeName()

Return the specified xml type name or the default type name if it is not specified

getSpecifiedXmlTypeName

java.lang.String getSpecifiedXmlTypeName()

Return the specified xml type name or null if it is not specified

setSpecifiedXmlTypeName

void setSpecifiedXmlTypeName(java.lang.String xmlTypeName)

Set the xml type name, null to unspecify (use the default)

getDefaultXmlTypeName

java.lang.String getDefaultXmlTypeName()

Return the default xml type name

getNamespace

java.lang.String getNamespace()

Return the specified xml type namespace or the default namespace if it is not specified

getSpecifiedNamespace

java.lang.String getSpecifiedNamespace()

Return the specified xml type namespace or null if it is not specified

setSpecifiedNamespace

void setSpecifiedNamespace(java.lang.String namespace)

Set the xml type namespace, null to unspecify (use the default)

getDefaultNamespace

java.lang.String getDefaultNamespace()

Return the default namespace

getPropOrder

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

propOrder corresponds to the XmlType annotation propOrder element

getPropOrderSize

int getPropOrderSize()

addProp

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

removeProp

void removeProp(int index)

removeProp

void removeProp(java.lang.String prop)

moveProp

void moveProp(int targetIndex,
              int sourceIndex)

isRootElement

boolean isRootElement()

Return whether this class is a root element (has the XmlRootElement annotation)

getRootElement

XmlRootElement getRootElement()

Return the root element or null if it is not a root element.

setRootElement

XmlRootElement setRootElement(java.lang.String name)

Set the root element name, this will add the XmlRootElement annotation and set its name to the specified name. To remove the XmlRootElement annotation, pass in null. To set the name when the class is already a root element, set it directly on the XmlRootElement.

getXsdTypeDefinition

XsdTypeDefinition getXsdTypeDefinition()