org.jomc.model

Class Modules

java.lang.Object

org.jomc.model.ModelObject

org.jomc.model.Modules

All Implemented Interfaces:

Cloneable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public class Modules
extends ModelObject
implements Cloneable

List of modules.

Java class for Modules complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Modules">
   <complexContent>
     <extension base="{http://jomc.org/model}ModelObject">
       <sequence>
         <element ref="{http://jomc.org/model}module" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Module>	module

Fields inherited from class org.jomc.model.ModelObject

authors, createDate, deprecated, documentation, MODEL_PUBLIC_ID, modelVersion

Constructor Summary

Constructors

Constructor and Description
Modules() Creates a new Modules instance.
Modules(Map<Object,Instance> objects) Creates a new Modules instance taking a map backing the instance.
Modules(Modules o) Creates a new Modules instance by deeply copying a given Modules instance.
Modules(Modules o, Map<Object,Instance> objects) Creates a new Modules instance by deeply copying a given Modules instance taking a map backing the instance.

Method Summary

Methods

Modifier and Type	Method and Description
Modules	clone() Creates and returns a deep copy of this object.
Object	createObject(Instance instance, ClassLoader classLoader) Creates an object of a given instance from the list of modules.
List<Object>	getAnyObjects(String implementation) Gets any objects of an implementation from the list of modules.
Module	getClasspathModule(String moduleName, ClassLoader classLoader) Gets a module holding model objects resolved by inspecting a given class loader.
static String	getDefaultClasspathModuleName() Gets the default classpath module name.
Dependencies	getDependencies(String implementation) Gets all dependencies of an implementation from the list of modules.
String	getDependencyJavaModifierName(String implementation, String dependency) Gets the Java modifier name of a dependency.
JavaTypeName	getDependencyJavaTypeName(String implementation, String dependency) Gets the Java type name of a dependency.
Implementation	getImplementation(Class<?> implementation) Gets an implementation declaring a given class from the list of modules.
Implementation	getImplementation(Object object) Gets an implementation for a given object from the list of modules.
Implementation	getImplementation(String implementation) Gets an implementation for a given identifier from the list of modules.
Implementation	getImplementation(String specification, String name) Gets an implementation for a given name implementing a given specification from the list of modules.
Implementations	getImplementations() Gets all implementations of the list of modules.
Implementations	getImplementations(String specification) Gets all implementations implementing a given specification from the list of modules.
List<JavaTypeName>	getImplementedJavaTypeNames(String implementation) Gets a list holding all JavaTypeNames an implementation implements from the list of modules.
Instance	getInstance(Object object) Gets the instance of an object from the list of modules.
Instance	getInstance(String implementation) Gets an instance for an implementation from the list of modules.
Instance	getInstance(String implementation, Dependency dependency) Gets an instance for an implementation from the list of modules overridden with a given dependency.
Module	getMergedModule(String name) Merges this list of modules to a single module.
String	getMessageJavaModifierName(String implementation, String message) Gets the Java modifier name of a message.
Messages	getMessages(String implementation) Gets all messages of an implementation from the list of modules.
List<Module>	getModule() Gets the value of the module property.
Module	getModule(String name) Gets a module for a given name from the list of modules.
Module	getModuleOfImplementation(String implementation) Gets the module declaring a given implementation from the list of modules.
Module	getModuleOfSpecification(String specification) Gets the module declaring a given specification from the list of modules.
Properties	getProperties(String implementation) Gets all properties of an implementation from the list of modules.
String	getPropertyJavaModifierName(String implementation, String property) Gets the Java modifier name of a property.
Specification	getSpecification(Class<?> specification) Gets a specification declaring a given class from the list of modules.
Specification	getSpecification(String specification) Gets a specification for a given identifier from the list of modules.
Specifications	getSpecifications() Gets all specifications of the list of modules.
Specifications	getSpecifications(String implementation) Gets all specifications an implementation implements from the list of modules.
Properties	getSpecifiedProperties(String implementation) Gets all properties specified for an implementation from the list of modules.
static void	setDefaultClasspathModuleName(String value) Sets the default classpath module name.

Methods inherited from class org.jomc.model.ModelObject

getAnyElement, getAnyElement, getAnyElements, getAnyElements, getAnyObject, getAnyObjects, getAuthors, getCreateDate, getDocumentation, getModelVersion, isDeprecated, setAuthors, setCreateDate, setDeprecated, setDocumentation, setModelVersion

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

module

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected List<Module> module

Constructor Detail

Modules

public Modules()

Creates a new Modules instance.

Modules

public Modules(Modules o)

Creates a new Modules instance by deeply copying a given Modules instance.

Parameters:

o - The instance to copy.

Throws:

NullPointerException - if o is null.

Modules

public Modules(Map<Object,Instance> objects)

Creates a new Modules instance taking a map backing the instance.

Parameters:

objects - The map backing the instance.

Modules

public Modules(Modules o,
       Map<Object,Instance> objects)

Creates a new Modules instance by deeply copying a given Modules instance taking a map backing the instance.

Parameters:

o - The instance to copy.

objects - The map backing the instance.

Throws:

NullPointerException - if o or objects is null.

Method Detail

getModule

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public List<Module> getModule()

Gets the value of the module property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the module property.

For example, to add a new item, do as follows:

    getModule().add(newItem);
 

Objects of the following type(s) are allowed in the list Module

clone

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Modules clone()

Creates and returns a deep copy of this object.

Overrides:

clone in class ModelObject

Returns:

A deep copy of this object.

getDefaultClasspathModuleName

public static String getDefaultClasspathModuleName()

Gets the default classpath module name.

The default classpath module name is controlled by system property org.jomc.model.Modules.defaultClasspathModuleName holding the default classpath module name. If that property is not set, the Java Classpath default is returned.

Returns:

The default classpath module name.

See Also:

getClasspathModule(java.lang.String, java.lang.ClassLoader)

setDefaultClasspathModuleName

public static void setDefaultClasspathModuleName(String value)

Sets the default classpath module name.

Parameters:

value - The new default classpath module name or null,

getClasspathModule

public Module getClasspathModule(String moduleName,
                        ClassLoader classLoader)

Gets a module holding model objects resolved by inspecting a given class loader.

This method searches this list of modules for unresolved references and tries to resolve each unresolved reference by inspecting the given class loader.

Parameters:

moduleName - The name of the module to return.

classLoader - The class loader to use for resolving entities or null, to resolve entities using the bootstrap class loader.

Returns:

A module holding model objects resolved by inspecting the given class loader or null, if nothing is resolved.

Throws:

NullPointerException - if moduleName is null.

See Also:

getDefaultClasspathModuleName(), getModule()

getModule

public Module getModule(String name)

Gets a module for a given name from the list of modules.

Parameters:

name - The name of the module to return.

Returns:

The first matching module or null, if no such module is found.

Throws:

NullPointerException - if name is null.

See Also:

getModule(), Module.getName()

getSpecifications

public Specifications getSpecifications()

Gets all specifications of the list of modules.

Returns:

All specifications or null, if no specifications are found.

See Also:

getModule()

getImplementations

public Implementations getImplementations()

Gets all implementations of the list of modules.

Returns:

All implementations or null, if no implementations are found.

See Also:

getModule()

getModuleOfSpecification

public Module getModuleOfSpecification(String specification)

Gets the module declaring a given specification from the list of modules.

Parameters:

specification - The identifier of the specification whose declaring module to return.

Returns:

The first matching module or null, if no such module is found.

Throws:

NullPointerException - if specification is null.

See Also:

getModule(), Module.getSpecifications(), Specifications.getSpecification( java.lang.String )

getModuleOfImplementation

public Module getModuleOfImplementation(String implementation)

Gets the module declaring a given implementation from the list of modules.

Parameters:

implementation - The identifier of the implementation whose declaring module to return.

Returns:

The first matching module or null, if no such module is found.

Throws:

NullPointerException - if implementation is null.

See Also:

getModule(), Module.getImplementations(), Implementations.getImplementation( java.lang.String )

getSpecification

public Specification getSpecification(String specification)

Gets a specification for a given identifier from the list of modules.

Parameters:

specification - The identifier of the specification to return.

Returns:

The first matching specification or null, if no such specification is found.

Throws:

NullPointerException - if specification is null.

See Also:

getModule(), Module.getSpecifications(), Specifications.getSpecification( java.lang.String )

getSpecification

public Specification getSpecification(Class<?> specification)
                               throws ModelObjectException

Gets a specification declaring a given class from the list of modules.

Parameters:

specification - The class of the specification to return.

Returns:

The first matching specification declaring the given class or null, if no such specification is found.

Throws:

NullPointerException - if specification is null.

ModelObjectException - if compiling a name of a referenced type to a JavaTypeName fails.

See Also:

getModule(), Module.getSpecifications(), Specifications.getSpecification( java.lang.Class )

getSpecifications

public Specifications getSpecifications(String implementation)

Gets all specifications an implementation implements from the list of modules.

Parameters:

implementation - The identifier of the implementation to get all implemented specifications of.

Returns:

All specifications implemented by the first matching implementation or null, if no such implementation is found or if the first matching implementation does not implement any specification.

Throws:

NullPointerException - if implementation is null.

See Also:

getModule(), getImplementation( java.lang.String ), Implementation.getImplementations(), Implementations.getReference(), Implementation.getSpecifications()

getImplementedJavaTypeNames

public List<JavaTypeName> getImplementedJavaTypeNames(String implementation)
                                               throws ModelObjectException

Gets a list holding all JavaTypeNames an implementation implements from the list of modules.

Parameters:

implementation - The identifier of the implementation to get all implemented specifications of.

Returns:

An unmodifiable list holding all JavaTypeNames implemented by the first matching implementation or null, if no such implementation is found or if that implementation does not implement any JavaTypeName.

Throws:

ModelObjectException - if compiling the name of a referenced type to a JavaTypeName fails.

Since:

1.4

See Also:

getSpecifications(java.lang.String), Specification.getJavaTypeName()

getImplementation

public Implementation getImplementation(String implementation)

Gets an implementation for a given identifier from the list of modules.

Parameters:

implementation - The identifier of the implementation to return.

Returns:

The first matching implementation or null, if no such implementation is found.

Throws:

NullPointerException - if implementation is null.

See Also:

getModule(), Module.getImplementations(), Implementations.getImplementation( java.lang.String )

getImplementation

public Implementation getImplementation(Class<?> implementation)
                                 throws ModelObjectException

Gets an implementation declaring a given class from the list of modules.

Parameters:

implementation - The class of the implementation to return.

Returns:

The first matching implementation declaring the given class or null, if no such implementation is found.

Throws:

NullPointerException - if implementation is null.

ModelObjectException - if compiling a name of a referenced type to a JavaTypeName fails.

See Also:

getModule(), Module.getImplementations(), Implementations.getImplementation( java.lang.Class )

getImplementation

public Implementation getImplementation(Object object)
                                 throws ModelObjectException

Gets an implementation for a given object from the list of modules.

Parameters:

object - The object of the implementation to return.

Returns:

The first matching implementation or null, if no such implementation is found.

Throws:

NullPointerException - if object is null.

ModelObjectException - if compiling a name of a referenced type to a JavaTypeName fails.

See Also:

getModule(), getImplementation( java.lang.Class )

getImplementation

public Implementation getImplementation(String specification,
                               String name)

Gets an implementation for a given name implementing a given specification from the list of modules.

Parameters:

specification - The identifier of the specification to return an implementation of.

name - The name of the implementation to return.

Returns:

The first matching implementation or null, if no such implementation is found.

Throws:

NullPointerException - if specification or name is null.

See Also:

getModule(), getImplementations( java.lang.String ), Implementations.getImplementationByName( java.lang.String )

getDependencies

public Dependencies getDependencies(String implementation)

Gets all dependencies of an implementation from the list of modules.

Parameters:

implementation - The identifier of the implementation to get all dependencies of.

Returns:

All dependencies of the first matching implementation or null, if no such implementation is found or if the first matching implementation does not have any dependencies.

Throws:

NullPointerException - if implementation is null.

See Also:

getModule(), getImplementation( java.lang.String ), Implementation.getImplementations(), Implementations.getReference(), Implementation.getDependencies()

getDependencyJavaTypeName

public JavaTypeName getDependencyJavaTypeName(String implementation,
                                     String dependency)
                                       throws ModelObjectException

Gets the Java type name of a dependency.

Parameters:

implementation - The identifier of the implementation of the dependency.

dependency - The name of the dependency to get the Java type name of.

Returns:

The Java type name of the dependency named dependency of the first matching implementation identified by implementation or null, if the implementation, the dependency or the referenced specification is not found or does not reference a Java type.

Throws:

NullPointerException - if implementation or dependency is null.

ModelObjectException - if compiling the name of the referenced type to a JavaTypeName fails.

Since:

1.4

See Also:

getDependencies(java.lang.String), Dependencies.getDependency(java.lang.String), getSpecification(java.lang.String), Specification.getJavaTypeName()

getDependencyJavaModifierName

public String getDependencyJavaModifierName(String implementation,
                                   String dependency)

Gets the Java modifier name of a dependency.

Parameters:

implementation - The identifier of the implementation of the dependency.

dependency - The name of the dependency to get the Java modifier name of.

Returns:

The Java modifier name of the dependency named dependency of the first matching implementation identified by implementation or null, if the implementation or the dependency is not found.

Throws:

NullPointerException - if implementation or dependency is null.

Since:

1.4

See Also:

getDependencies(java.lang.String), Dependencies.getDependency(java.lang.String)

getProperties

public Properties getProperties(String implementation)

Gets all properties of an implementation from the list of modules.

Parameters:

implementation - The identifier of the implementation to get all properties of.

Returns:

All properties of the first matching implementation or null, if no such implementation is found or if the first matching implementation does not have any properties.

Throws:

NullPointerException - if implementation is null.

See Also:

getModule(), getImplementation( java.lang.String ), Implementation.getImplementations(), Implementations.getReference(), Implementation.getProperties()

getSpecifiedProperties

public Properties getSpecifiedProperties(String implementation)

Gets all properties specified for an implementation from the list of modules.

Parameters:

implementation - The identifier of the implementation to return specified properties of.

Returns:

All properties specified for the first matching implementation or null, if no such implementation is found or if the first matching implementation does not have any specified properties.

Throws:

NullPointerException - if implementation is null.

See Also:

getModule(), getSpecifications( java.lang.String ), Specification.getProperties()

getPropertyJavaModifierName

public String getPropertyJavaModifierName(String implementation,
                                 String property)

Gets the Java modifier name of a property.

Parameters:

implementation - The identifier of the implementation of the property.

property - The name of the property to get the Java modifier name of.

Returns:

The Java modifier name of the property named property of the first matching implementation identified by implementation or null, if the implementation or the property is not found.

Throws:

NullPointerException - if implementation or dependency is null.

Since:

1.4

See Also:

getProperties(java.lang.String), Properties.getProperty(java.lang.String)

getMessages

public Messages getMessages(String implementation)

Gets all messages of an implementation from the list of modules.

Parameters:

implementation - The identifier of the implementation to get all messages of.

Returns:

All messages of the first matching implementation or null, if no such implementation is found or if the first matching implementation does not have any messages.

Throws:

NullPointerException - if implementation is null.

See Also:

getModule(), getImplementation( java.lang.String ), Implementation.getImplementations(), Implementations.getReference(), Implementation.getMessages()

getMessageJavaModifierName

public String getMessageJavaModifierName(String implementation,
                                String message)

Gets the Java modifier name of a message.

Parameters:

implementation - The identifier of the implementation of the message.

message - The name of the message to get the Java modifier name of.

Returns:

The Java modifier name of the message named message of the first matching implementation identified by implementation or null, if the implementation or the message is not found.

Throws:

NullPointerException - if implementation or message is null.

Since:

1.4

See Also:

getMessages(java.lang.String), Messages.getMessage(java.lang.String)

getAnyObjects

public List<Object> getAnyObjects(String implementation)

Gets any objects of an implementation from the list of modules.

Parameters:

implementation - The identifier of the implementation to get any objects of.

Returns:

Any objects of the first matching implementation or null, if no such implementation is found.

Throws:

NullPointerException - if implementation is null.

Since:

1.2

See Also:

getModule(), getImplementation( java.lang.String ), Implementation.getImplementations(), Implementations.getReference(), Implementation.getAny()

getImplementations

public Implementations getImplementations(String specification)

Gets all implementations implementing a given specification from the list of modules.

Parameters:

specification - The identifier of the specification to return all implementations of.

Returns:

All implementations implementing the first matching specification or null, if no such specification is found or if the first matching specification does not have any implementations.

Throws:

NullPointerException - if specification is null.

See Also:

getModule(), getSpecifications( java.lang.String )

getMergedModule

public Module getMergedModule(String name)

Merges this list of modules to a single module.

Parameters:

name - The name of the module to return.

Returns:

A module holding all model objects from the list.

Throws:

NullPointerException - if name is null.

getInstance

public Instance getInstance(Object object)
                     throws ModelObjectException

Gets the instance of an object from the list of modules.

Parameters:

object - The object to get the instance of.

Returns:

The instance of object or null, if no such instance is found.

Throws:

NullPointerException - if object is null.

ModelObjectException - if compiling a name of a referenced type to a JavaTypeName fails.

See Also:

getModule(), getImplementation( java.lang.Object ), getInstance( java.lang.String ), createObject(org.jomc.model.Instance instance, java.lang.ClassLoader classLoader)

getInstance

public Instance getInstance(String implementation)

Gets an instance for an implementation from the list of modules.

Parameters:

implementation - The identifier of the implementation to get an instance for.

Returns:

A new instance for the first matching implementation or null, if no such implementation is found.

Throws:

NullPointerException - if implementation is null.

See Also:

getModule(), getImplementation( java.lang.String ), getDependencies(java.lang.String), getProperties(java.lang.String), getMessages(java.lang.String), getSpecifications(java.lang.String), getAnyObjects(java.lang.String)

getInstance

public Instance getInstance(String implementation,
                   Dependency dependency)

Gets an instance for an implementation from the list of modules overridden with a given dependency.

Parameters:

implementation - The identifier of the implementation to get an instance for.

dependency - The dependency to use for overriding model objects of the instance.

Returns:

An instance for the first matching implementation with any model objects overridden using dependency or null, if no such implementation is found.

Throws:

NullPointerException - if implementation or dependency is null.

See Also:

getModule(), getInstance( java.lang.String )

createObject

public Object createObject(Instance instance,
                  ClassLoader classLoader)
                    throws ModelObjectException,
                           InstantiationException

Creates an object of a given instance from the list of modules.

Parameters:

instance - The instance to create an object of.

classLoader - The class loader to use for creating the object or null, to use the bootstrap class loader.

Returns:

A new object of instance.

Throws:

NullPointerException - if instance is null.

ModelObjectException - if compiling the name of a referenced type to a JavaTypeName fails.

InstantiationException - if creating an object fails.

See Also:

getModule(), Instance.getJavaClass(java.lang.ClassLoader), Instance.getJavaConstructor(java.lang.ClassLoader), Instance.getJavaFactoryMethodName(), Instance.getJavaFactoryMethod(java.lang.ClassLoader), Instance.isJavaClassAssignable(java.lang.ClassLoader)