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

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IResourcePart, JavaContextNode, JaxbClass, JaxbContextNode, JaxbNode, JaxbPersistentType, JaxbType, Model, XmlAccessOrderHolder, XmlAccessTypeHolder, XmlAdaptable

public interface JaxbPersistentClass
extends JaxbPersistentType, JaxbClass, XmlAdaptable

Represents a JAXB persistent class. (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
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAdaptable
XmlAdaptable.Owner
 
Field Summary
static java.lang.String ATTRIBUTES_COLLECTION
           
static java.lang.String INHERITED_ATTRIBUTES_COLLECTION
           
static java.lang.String XML_SEE_ALSO_PROPERTY
           
 
Fields inherited from interface org.eclipse.jpt.jaxb.core.context.JaxbPersistentType
FACTORY_CLASS_PROPERTY, FACTORY_METHOD_PROPERTY, PROP_ORDER_LIST, ROOT_ELEMENT, SPECIFIED_NAMESPACE_PROPERTY, SPECIFIED_XML_TYPE_NAME_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.jaxb.core.context.JaxbClass
SUPER_CLASS_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAccessTypeHolder
DEFAULT_ACCESS_TYPE_PROPERTY, SPECIFIED_ACCESS_TYPE_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAccessOrderHolder
DEFAULT_ACCESS_ORDER_PROPERTY, SPECIFIED_ACCESS_ORDER_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAdaptable
XML_JAVA_TYPE_ADAPTER_PROPERTY
 
Method Summary
 XmlSeeAlso addXmlSeeAlso()
           
 boolean containsXmlId()
          Return true if 1 or more attributes include the @XmlId annotation
 java.lang.Iterable<JaxbPersistentAttribute> getAttributes()
          attributes
 int getAttributesSize()
           
 java.lang.Iterable<JaxbPersistentAttribute> getInheritedAttributes()
          Inherited attributes come from any superclasses that are mapped as @XmlTransient.
 int getInheritedAttributesSize()
           
 java.lang.String getJavaResourceAttributeOwningTypeName(JaxbPersistentAttribute attribute)
          Only ask this of inherited persistent attributes.
 XmlSeeAlso getXmlSeeAlso()
           
 boolean isInherited(JaxbPersistentAttribute attribute)
          Return true if the given attribute is one of the inherited attributes.
 void removeXmlSeeAlso()
           
 
Methods inherited from interface org.eclipse.jpt.jaxb.core.context.JaxbPersistentType
addProp, getDefaultNamespace, getDefaultXmlTypeName, getFactoryClass, getFactoryMethod, getNamespace, getPropOrder, getPropOrderSize, getRootElement, getSpecifiedNamespace, getSpecifiedXmlTypeName, getXmlTypeName, getXsdTypeDefinition, isRootElement, moveProp, removeProp, removeProp, setFactoryClass, setFactoryMethod, setRootElement, setSpecifiedNamespace, setSpecifiedXmlTypeName
 
Methods inherited from interface org.eclipse.jpt.jaxb.core.context.JaxbClass
getAncestors, getInheritanceHierarchy, getJavaResourceType, getSuperClass
 
Methods inherited from interface org.eclipse.jpt.jaxb.core.context.JaxbType
getDirectlyReferencedTypeNames, getFullyQualifiedName, 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
 
Methods inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAccessTypeHolder
getAccessType, getDefaultAccessType, getSpecifiedAccessType, setSpecifiedAccessType
 
Methods inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAccessOrderHolder
getAccessOrder, getDefaultAccessOrder, getSpecifiedAccessOrder, setSpecifiedAccessOrder
 
Methods inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAdaptable
addXmlJavaTypeAdapter, getXmlJavaTypeAdapter, removeXmlJavaTypeAdapter
 

Field Detail

XML_SEE_ALSO_PROPERTY

static final java.lang.String XML_SEE_ALSO_PROPERTY
See Also:
Constant Field Values

ATTRIBUTES_COLLECTION

static final java.lang.String ATTRIBUTES_COLLECTION
See Also:
Constant Field Values

INHERITED_ATTRIBUTES_COLLECTION

static final java.lang.String INHERITED_ATTRIBUTES_COLLECTION
See Also:
Constant Field Values
Method Detail

getXmlSeeAlso

XmlSeeAlso getXmlSeeAlso()

addXmlSeeAlso

XmlSeeAlso addXmlSeeAlso()

removeXmlSeeAlso

void removeXmlSeeAlso()

getAttributes

java.lang.Iterable<JaxbPersistentAttribute> getAttributes()
attributes


getAttributesSize

int getAttributesSize()

getInheritedAttributes

java.lang.Iterable<JaxbPersistentAttribute> getInheritedAttributes()
Inherited attributes come from any superclasses that are mapped as @XmlTransient.

See Also:
JaxbClass.getSuperClass(), JaxbClass.getInheritanceHierarchy()

getInheritedAttributesSize

int getInheritedAttributesSize()

isInherited

boolean isInherited(JaxbPersistentAttribute attribute)
Return true if the given attribute is one of the inherited attributes.


getJavaResourceAttributeOwningTypeName

java.lang.String getJavaResourceAttributeOwningTypeName(JaxbPersistentAttribute attribute)
Only ask this of inherited persistent attributes. Returns the simple type name of the attribute's resource type.

See Also:
JaxbPersistentAttribute.isInherited()

containsXmlId

boolean containsXmlId()
Return true if 1 or more attributes include the @XmlId annotation