org.jomc.model
Class Module

java.lang.Object
  org.jomc.model.ModelObject
      org.jomc.model.Module

All Implemented Interfaces:

Cloneable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public class Module
extends ModelObject
implements Cloneable

Model of a module. The 'Module' type defines attributes 'name', 'version' and 'vendor'. Attribute 'name' holds the name of the module uniquely identifying the module in a set of modules. Attribute 'vendor' holds information regarding the vendor of the module. Attribute 'version' holds the version of the module. A module defines implementations, messages, properties and specifications.

Java class for Module complex type.

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

 <complexType name="Module">
   <complexContent>
     <extension base="{http://jomc.org/model}ModelObject">
       <sequence>
         <element ref="{http://jomc.org/model}specifications" minOccurs="0"/>
         <element ref="{http://jomc.org/model}implementations" minOccurs="0"/>
         <element ref="{http://jomc.org/model}properties" minOccurs="0"/>
         <element ref="{http://jomc.org/model}messages" minOccurs="0"/>
         <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="name" use="required" type="{http://jomc.org/model}Identifier" />
       <attribute name="version" type="{http://jomc.org/model}Version" />
       <attribute name="vendor" type="{http://jomc.org/model}String" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

protected List<Object>	any
protected Implementations	implementations
protected Messages	messages
protected String	name
protected Properties	properties
protected Specifications	specifications
protected String	vendor
protected String	version

Fields inherited from class org.jomc.model.ModelObject

authors, createDate, deprecated, documentation, MODEL_PUBLIC_ID, modelVersion

Constructor Summary

Module()
Creates a new Module instance.

Module(Module o)
Creates a new Module instance by deeply copying a given Module instance.

Method Summary

Module	clone() Creates and returns a deep copy of this object.
List<Object>	getAny() Gets the value of the any property.
javax.xml.bind.JAXBElement	getAnyElement(String namespaceURI, String localPart) Deprecated. As of JOMC 1.1, please use method getAnyElement(java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.
<T> javax.xml.bind.JAXBElement<T>	getAnyElement(String namespaceURI, String localPart, Class<T> type) Gets a single JAXBElement matching a namespace URI and local part from the any property of the instance.
List<javax.xml.bind.JAXBElement>	getAnyElements(String namespaceURI, String localPart) Deprecated. As of JOMC 1.1, please use method getAnyElements(java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.
<T> List<javax.xml.bind.JAXBElement<T>>	getAnyElements(String namespaceURI, String localPart, Class<T> type) Gets a list containing all JAXBElements matching a namespace URI and local part from the any property of the instance.
<T> T	getAnyObject(Class<T> clazz) Gets a single object matching a given class from the any property of the instance.
<T> List<T>	getAnyObjects(Class<T> clazz) Gets a list containing all objects matching a given class from the any property of the instance.
Implementations	getImplementations() Implementations of this module or null.
Messages	getMessages() Messages of this module or null.
String	getName() Name of this module.
Properties	getProperties() Properties of this module or null.
Specifications	getSpecifications() Specifications of this module or null.
String	getVendor() Vendor of this module or null.
String	getVersion() Version of this module or null.
void	setImplementations(Implementations value) Sets the value of the implementations property.
void	setMessages(Messages value) Sets the value of the messages property.
void	setName(String value) Sets the value of the name property.
void	setProperties(Properties value) Sets the value of the properties property.
void	setSpecifications(Specifications value) Sets the value of the specifications property.
void	setVendor(String value) Sets the value of the vendor property.
void	setVersion(String value) Sets the value of the version property.

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

specifications

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Specifications specifications

implementations

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Implementations implementations

properties

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Properties properties

messages

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Messages messages

any

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected List<Object> any

name

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String name

version

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String version

vendor

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String vendor

Constructor Detail

Module

public Module()

Creates a new Module instance.

Module

public Module(Module o)

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

Parameters:

o - The instance to copy.

Throws:

NullPointerException - if o is null.

Method Detail

getSpecifications

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Specifications getSpecifications()

Specifications of this module or null.

Returns:

possible object is Specifications

setSpecifications

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setSpecifications(Specifications value)

Sets the value of the specifications property.

Parameters:

value - allowed object is Specifications

getImplementations

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Implementations getImplementations()

Implementations of this module or null.

Returns:

possible object is Implementations

setImplementations

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setImplementations(Implementations value)

Sets the value of the implementations property.

Parameters:

value - allowed object is Implementations

getProperties

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Properties getProperties()

Properties of this module or null.

Returns:

possible object is Properties

setProperties

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setProperties(Properties value)

Sets the value of the properties property.

Parameters:

value - allowed object is Properties

getMessages

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Messages getMessages()

Messages of this module or null.

Returns:

possible object is Messages

setMessages

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setMessages(Messages value)

Sets the value of the messages property.

Parameters:

value - allowed object is Messages

getAny

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public List<Object> getAny()

Gets the value of the any 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 any property.

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

    getAny().add(newItem);
 

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

getName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getName()

Name of this module.

Returns:

possible object is String

setName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

getVersion

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getVersion()

Version of this module or null.

Returns:

possible object is String

setVersion

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setVersion(String value)

Sets the value of the version property.

Parameters:

value - allowed object is String

getVendor

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getVendor()

Vendor of this module or null.

Returns:

possible object is String

setVendor

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setVendor(String value)

Sets the value of the vendor property.

Parameters:

value - allowed object is String

clone

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-26T04:53:34+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Module clone()

Creates and returns a deep copy of this object.

Overrides:

clone in class ModelObject

Returns:

A deep copy of this object.

getAnyElement

@Deprecated
public javax.xml.bind.JAXBElement getAnyElement(String namespaceURI,
                                                           String localPart)

Deprecated. As of JOMC 1.1, please use method getAnyElement(java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.

Gets a single JAXBElement matching a namespace URI and local part from the any property of the instance.

Parameters:

namespaceURI - The namespace URI of the JAXBElement to return.

localPart - The local part of the JAXBElement to return.

Returns:

The JAXBElement matching namespaceURI and localPart from the any property of the instance or null, if no such element is found.

Throws:

NullPointerException - if namespaceURI or localPart is null.

IllegalStateException - if the any property contains more than one matching element.

See Also:

ModelObject.getAnyElement(java.util.List, java.lang.String, java.lang.String)

getAnyElements

@Deprecated
public List<javax.xml.bind.JAXBElement> getAnyElements(String namespaceURI,
                                                                  String localPart)

Deprecated. As of JOMC 1.1, please use method getAnyElements(java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.

Gets a list containing all JAXBElements matching a namespace URI and local part from the any property of the instance.

Parameters:

namespaceURI - The namespace URI of the JAXBElements to return.

localPart - The local part of the JAXBElements to return.

Returns:

An unmodifiable list of all JAXBElements matching namespaceURI and localPart from the any property of the instance - an empty list if no such elements are found.

Throws:

NullPointerException - if namespaceURI or localPart is null.

See Also:

ModelObject.getAnyElements(java.util.List, java.lang.String, java.lang.String)

getAnyElement

public <T> javax.xml.bind.JAXBElement<T> getAnyElement(String namespaceURI,
                                                       String localPart,
                                                       Class<T> type)

Gets a single JAXBElement matching a namespace URI and local part from the any property of the instance.

Type Parameters:

T - The type the element is bound to.

Parameters:

namespaceURI - The namespace URI of the JAXBElement to return.

localPart - The local part of the JAXBElement to return.

type - The class of the type the element is bound to.

Returns:

The JAXBElement matching namespaceURI and localPart from the any property of the instance or null, if no such element is found.

Throws:

NullPointerException - if namespaceURI, localPart or type is null.

IllegalStateException - if the any property contains more than one matching element.

Since:

1.1

See Also:

ModelObject.getAnyElement(java.util.List, java.lang.String, java.lang.String, java.lang.Class)

getAnyElements

public <T> List<javax.xml.bind.JAXBElement<T>> getAnyElements(String namespaceURI,
                                                              String localPart,
                                                              Class<T> type)

Gets a list containing all JAXBElements matching a namespace URI and local part from the any property of the instance.

Type Parameters:

T - The type the elements are bound to.

Parameters:

namespaceURI - The namespace URI of the JAXBElements to return.

localPart - The local part of the JAXBElements to return.

type - The class of the type the elements are bound to.

Returns:

An unmodifiable list of all JAXBElements matching namespaceURI and localPart from the any property of the instance - an empty list if no such elements are found.

Throws:

NullPointerException - if namespaceURI, localPart or type is null.

Since:

1.1

See Also:

ModelObject.getAnyElements(java.util.List, java.lang.String, java.lang.String, java.lang.Class)

getAnyObject

public <T> T getAnyObject(Class<T> clazz)

Gets a single object matching a given class from the any property of the instance.

Type Parameters:

T - The type of the object to return.

Parameters:

clazz - The class to return an instance of.

Returns:

The instance of clazz from the any property of the instance or null, if no such instance is found.

Throws:

NullPointerException - if clazz is null.

IllegalStateException - if the any property contains more than one matching object.

See Also:

ModelObject.getAnyObject(java.util.List, java.lang.Class)

getAnyObjects

public <T> List<T> getAnyObjects(Class<T> clazz)

Gets a list containing all objects matching a given class from the any property of the instance.

Type Parameters:

T - The type of the objects to return.

Parameters:

clazz - The class to return all instances of.

Returns:

An unmodifiable list of all instances of clazz from the any property of the instance - an empty list if no such objects are found.

Throws:

NullPointerException - if clazz is null.

See Also:

ModelObject.getAnyObjects(java.util.List, java.lang.Class)