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

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IResourcePart, JaxbContextNode, JaxbNode, Model

public interface JaxbContextRoot
extends JaxbContextNode

Root of the JAXB context model.

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

Field Summary
static java.lang.String PACKAGES_COLLECTION
           
static java.lang.String TYPES_COLLECTION
           
 
Method Summary
 JaxbClass getClass(java.lang.String fullyQualifiedTypeName)
          Return the persistent class or transient type with the given fully qualified name
 JaxbPackage getPackage(java.lang.String packageName)
          Return the package with the given name
 java.lang.Iterable<JaxbPackage> getPackages()
          The set of packages.
 int getPackagesSize()
           
 JaxbPersistentClass getPersistentClass(java.lang.String fullyQualifiedTypeName)
          Return the persistent class with the given fully qualified name
 java.lang.Iterable<JaxbPersistentClass> getPersistentClasses()
          The set of persistent classes.
 java.lang.Iterable<JaxbPersistentClass> getPersistentClasses(JaxbPackage jaxbPackage)
          Return the set of persistent classes that are in the given package
 JaxbPersistentEnum getPersistentEnum(java.lang.String fullyQualifiedTypeName)
          Return the persistent enum with the given fully qualified name
 java.lang.Iterable<JaxbPersistentEnum> getPersistentEnums()
          The set of persistent enums.
 java.lang.Iterable<JaxbPersistentEnum> getPersistentEnums(JaxbPackage jaxbPackage)
          Return the set of persistent enums that are in the given package
 java.lang.Iterable<JaxbRegistry> getRegistries()
          The set of registries.
 java.lang.Iterable<JaxbRegistry> getRegistries(JaxbPackage jaxbPackage)
          Return the set of registries that are in the given package (There should typically be a max of 1, but there are invalid states ...)
 JaxbTransientClass getTransientClass(java.lang.String fullyQualifiedTypeName)
          Return the transient class with the given fully qualified name
 java.lang.Iterable<JaxbTransientClass> getTransientClasses()
          The set of transient classes.
 java.lang.Iterable<JaxbTransientClass> getTransientClasses(JaxbPackage jaxbPackage)
          Return the set of transient classes that are in the given package
 JaxbType getType(java.lang.String typeName)
          Return the type with the given name
 java.lang.Iterable<JaxbType> getTypes()
          Return the set of all JAXB types within this context root.
 java.lang.Iterable<JaxbType> getTypes(JaxbPackage jaxbPackage)
          Return the set of types that are in the given package
 int getTypesSize()
           
 void validate(java.util.List<org.eclipse.wst.validation.internal.provisional.core.IMessage> messages, org.eclipse.wst.validation.internal.provisional.core.IReporter reporter)
          Add validation messages to the specified list.
 
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

PACKAGES_COLLECTION

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

TYPES_COLLECTION

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

getPackages

java.lang.Iterable<JaxbPackage> getPackages()
The set of packages. Includes any package with any interesting JAXB content.


getPackagesSize

int getPackagesSize()

getPackage

JaxbPackage getPackage(java.lang.String packageName)
Return the package with the given name


getTypes

java.lang.Iterable<JaxbType> getTypes()
Return the set of all JAXB types within this context root.


getTypesSize

int getTypesSize()

getType

JaxbType getType(java.lang.String typeName)
Return the type with the given name


getTypes

java.lang.Iterable<JaxbType> getTypes(JaxbPackage jaxbPackage)
Return the set of types that are in the given package


getPersistentClasses

java.lang.Iterable<JaxbPersistentClass> getPersistentClasses()
The set of persistent classes. These may be explicitly or implicitly included.


getPersistentClasses

java.lang.Iterable<JaxbPersistentClass> getPersistentClasses(JaxbPackage jaxbPackage)
Return the set of persistent classes that are in the given package


getPersistentClass

JaxbPersistentClass getPersistentClass(java.lang.String fullyQualifiedTypeName)
Return the persistent class with the given fully qualified name


getPersistentEnums

java.lang.Iterable<JaxbPersistentEnum> getPersistentEnums()
The set of persistent enums. These may be explicitly or implicitly included.


getPersistentEnums

java.lang.Iterable<JaxbPersistentEnum> getPersistentEnums(JaxbPackage jaxbPackage)
Return the set of persistent enums that are in the given package


getPersistentEnum

JaxbPersistentEnum getPersistentEnum(java.lang.String fullyQualifiedTypeName)
Return the persistent enum with the given fully qualified name


getRegistries

java.lang.Iterable<JaxbRegistry> getRegistries()
The set of registries.


getRegistries

java.lang.Iterable<JaxbRegistry> getRegistries(JaxbPackage jaxbPackage)
Return the set of registries that are in the given package (There should typically be a max of 1, but there are invalid states ...)


getTransientClasses

java.lang.Iterable<JaxbTransientClass> getTransientClasses()
The set of transient classes.


getTransientClasses

java.lang.Iterable<JaxbTransientClass> getTransientClasses(JaxbPackage jaxbPackage)
Return the set of transient classes that are in the given package


getTransientClass

JaxbTransientClass getTransientClass(java.lang.String fullyQualifiedTypeName)
Return the transient class with the given fully qualified name


getClass

JaxbClass getClass(java.lang.String fullyQualifiedTypeName)
Return the persistent class or transient type with the given fully qualified name


validate

void validate(java.util.List<org.eclipse.wst.validation.internal.provisional.core.IMessage> messages,
              org.eclipse.wst.validation.internal.provisional.core.IReporter reporter)
Add validation messages to the specified list.