org.jomc.model
Class Modules

Package class diagram package Modules
java.lang.Object
  extended by org.jomc.model.ModelObject
      extended by org.jomc.model.Modules
All Implemented Interfaces:
Cloneable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-10-04T12:50:46+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public class Modules
extends ModelObject
implements Cloneable

List of modules.

Queries

See Also:
Module

Field Summary
protected  List<Module> module
           
 
Fields inherited from class org.jomc.model.ModelObject
authors, createDate, deprecated, documentation, modelVersion
 
Constructor Summary
Modules()
          Creates a new Modules instance.
Modules(Modules o)
          Creates a new Modules instance by deeply copying a given instance.
 
Method Summary
 Modules clone()
          Creates and returns a deep copy of this object.
(package private)  void collectDependencies(Implementation implementation, Dependencies dependencies, Implementations seen, boolean includeDeclared)
           
(package private)  void collectMessages(Implementation implementation, Messages messages, Implementations seen, boolean includeDeclared)
           
(package private)  void collectProperties(Implementation implementation, Properties properties, Implementations seen, boolean includeDeclared)
           
(package private)  void collectSpecifications(Implementation implementation, Specifications specifications, Implementations seen, boolean includeDeclared)
           
private static void copyModule(List<Module> source, List<Module> target)
          Copies all values of property Module deeply.
 Dependencies getDependencies(String implementation)
          Gets all dependencies of an implementation from this list of modules.
 Implementation getImplementation(Class implementation)
          Gets an implementation for a given class from this list of modules.
 Implementation getImplementation(String implementation)
          Gets an implementation for a given identifier from this list of modules.
 Implementation getImplementation(String specification, String name)
          Gets an implementation for a given name implementing a given specification from this list of modules.
 Implementations getImplementations()
          Gets all implementations declared in this list of modules.
 Implementations getImplementations(String specification)
          Gets all implementations implementing a given specification from this list of modules.
 Module getMergedModule()
          Merges this list of modules to a single module.
 Messages getMessages(String implementation)
          Gets all messages of an implementation from this 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 this list of modules.
 Module getModuleOfImplementation(String implementation)
          Gets the module declaring a given implementation from this list of modules.
 Module getModuleOfSpecification(String specification)
          Gets the module declaring a given specification from this list of modules.
 Properties getProperties(String implementation)
          Gets all properties of an implementation from this list of modules.
 Specification getSpecification(Class specification)
          Gets a specification for a given class from this list of modules.
 Specification getSpecification(String specification)
          Gets a specification for a given identifier from this list of modules.
 Specifications getSpecifications()
          Gets all specifications declared in this list of modules.
 Specifications getSpecifications(String implementation)
          Gets all specifications an implementation implements from this list of modules.
 Properties getSpecifiedProperties(String implementation)
          Gets all properties specified for an implementation from this list of modules.
 
Methods inherited from class org.jomc.model.ModelObject
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="2009-10-04T12:50:46+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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 instance.

Parameters:
o - The instance to copy or null.
Method Detail

getModule

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-10-04T12:50:46+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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


copyModule

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-10-04T12:50:46+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static void copyModule(List<Module> source,
                                                          List<Module> target)
Copies all values of property Module deeply.

Parameters:
target - The target to copy source to.
source - The source to copy from.
Throws:
NullPointerException - if source or target is null.

clone

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-10-04T12:50:46+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public Modules clone()
Creates and returns a deep copy of this object.

Overrides:
clone in class ModelObject
Returns:
A deep copy of this object.

getModule

public Module getModule(String name)
Gets a module for a given name from this list of modules.

Parameters:
name - The name of the module to return.
Returns:
The module with name name from the list or null, if no module matching name is found.
Throws:
NullPointerException - if name is null.
See Also:
getModule()

getSpecifications

public Specifications getSpecifications()
Gets all specifications declared in this list of modules.

Returns:
All specifications declared in the list or null, if no specifications are declared.
See Also:
getModule()

getImplementations

public Implementations getImplementations()
Gets all implementations declared in this list of modules.

Returns:
All implementations declared in the list or null, if no implementations are declared.
See Also:
getModule()

getModuleOfSpecification

public Module getModuleOfSpecification(String specification)
Gets the module declaring a given specification from this list of modules.

Parameters:
specification - The identifier of the specification whose declaring module to return.
Returns:
The module declaring specification from the list or null, if no module is found declaring specification.
Throws:
NullPointerException - if specification is null.
See Also:
getModule()

getModuleOfImplementation

public Module getModuleOfImplementation(String implementation)
Gets the module declaring a given implementation from this list of modules.

Parameters:
implementation - The identifier of the implementation whose declaring module to return.
Returns:
The module declaring implementation from the list or null, if no module is found declaring implementation.
Throws:
NullPointerException - if implementation is null.
See Also:
getModule()

getSpecification

public Specification getSpecification(String specification)
Gets a specification for a given identifier from this list of modules.

Parameters:
specification - The identifier of the specification to return.
Returns:
The specification identified by specification from the list or null, if no specification matching specification is found.
Throws:
NullPointerException - if specification is null.
See Also:
getModule()

getSpecification

public Specification getSpecification(Class specification)
Gets a specification for a given class from this list of modules.

Parameters:
specification - The class of the specification to return.
Returns:
The specification identified by specification from the list or null, if no specification matching specification is found.
Throws:
NullPointerException - if specification is null.
See Also:
getModule()

getSpecifications

public Specifications getSpecifications(String implementation)
Gets all specifications an implementation implements from this list of modules.

Parameters:
implementation - The identifier of the implementation to get all implemented specifications of.
Returns:
List of all specifications implemented by implementation from the list or null, if no implementation matching implementation is found.
Throws:
NullPointerException - if implementation is null.
See Also:
getModule()

collectSpecifications

void collectSpecifications(Implementation implementation,
                           Specifications specifications,
                           Implementations seen,
                           boolean includeDeclared)

getImplementation

public Implementation getImplementation(String implementation)
Gets an implementation for a given identifier from this list of modules.

Parameters:
implementation - The identifier of the implementation to return.
Returns:
The implementation identified by implementation from the list or null, if no implementation matching implementation is found.
Throws:
NullPointerException - if implementation is null.
See Also:
getModule()

getImplementation

public Implementation getImplementation(Class implementation)
Gets an implementation for a given class from this list of modules.

Parameters:
implementation - The class of the implementation to return.
Returns:
The implementation identified by implementation from the list or null, if no implementation matching implementation is found.
Throws:
NullPointerException - if implementation is null.
See Also:
getModule()

getImplementation

public Implementation getImplementation(String specification,
                                        String name)
Gets an implementation for a given name implementing a given specification from this 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 implementation with name name implementing the specification identified by specification from the list or null, if no such implementation is found.
Throws:
NullPointerException - if specification or name is null.
See Also:
getModule()

getDependencies

public Dependencies getDependencies(String implementation)
Gets all dependencies of an implementation from this list of modules.

Parameters:
implementation - The identifier of the implementation to get all dependencies of.
Returns:
List of all dependencies of implementation from the list or null, if no dependencies are found.
Throws:
NullPointerException - if implementation is null.
See Also:
getModule()

collectDependencies

void collectDependencies(Implementation implementation,
                         Dependencies dependencies,
                         Implementations seen,
                         boolean includeDeclared)

getProperties

public Properties getProperties(String implementation)
Gets all properties of an implementation from this list of modules.

Parameters:
implementation - The identifier of the implementation to get all properties of.
Returns:
List of all properties of implementation from the list or null, if no properties are found.
Throws:
NullPointerException - if implementation is null.
See Also:
getModule()

collectProperties

void collectProperties(Implementation implementation,
                       Properties properties,
                       Implementations seen,
                       boolean includeDeclared)

getSpecifiedProperties

public Properties getSpecifiedProperties(String implementation)
Gets all properties specified for an implementation from this list of modules.

Parameters:
implementation - The identifier of the implementation to return specified properties of.
Returns:
List of all properties specified for implementation from the list or null, if no properties are found.
Throws:
NullPointerException - if implementation is null.
See Also:
getModule()

getMessages

public Messages getMessages(String implementation)
Gets all messages of an implementation from this list of modules.

Parameters:
implementation - The identifier of the implementation to get all messages of.
Returns:
List of messages of implementation from the list or null, if no messages are found.
Throws:
NullPointerException - if implementation is null.
See Also:
getModule()

collectMessages

void collectMessages(Implementation implementation,
                     Messages messages,
                     Implementations seen,
                     boolean includeDeclared)

getImplementations

public Implementations getImplementations(String specification)
Gets all implementations implementing a given specification from this list of modules.

Parameters:
specification - The identifier of the specification to return implementations of.
Returns:
All implementations implementing the specification identified by specification from the list or null, if no implementation implementing specification is found.
Throws:
NullPointerException - if specification is null.
See Also:
getModule()

getMergedModule

public Module getMergedModule()
Merges this list of modules to a single module.

Returns:
A module holding all model objects from the list.


Copyright © 2005-2009 The JOMC Project. All Rights Reserved.