org.jomc.model

Class ModelObject

java.lang.Object

org.jomc.model.ModelObject

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

Argument, Arguments, Authors, Dependencies, Implementation, ImplementationReference, Implementations, Instance, Instances, Message, MessageReference, Messages, Module, Modules, Person, Persons, Properties, Property, PropertyReference, Specification, SpecificationReference, Specifications

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public class ModelObject
extends Object
implements Cloneable

Base model object.

Java class for ModelObject complex type.

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

 <complexType name="ModelObject">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://jomc.org/model}documentation" minOccurs="0"/>
         <element ref="{http://jomc.org/model}authors" minOccurs="0"/>
       </sequence>
       <attribute name="modelVersion" type="{http://jomc.org/model}Version" default="1.2" />
       <attribute name="createDate" type="{http://jomc.org/model}DateTime" />
       <attribute name="deprecated" type="{http://jomc.org/model}Flag" default="false" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected Authors	authors
protected XMLGregorianCalendar	createDate
protected Boolean	deprecated
protected Texts	documentation
static String	MODEL_PUBLIC_ID Public identifier of the object management and configuration model.
protected String	modelVersion

Constructor Summary

Constructors

Constructor and Description
ModelObject() Creates a new ModelObject instance.
ModelObject(ModelObject o) Creates a new ModelObject instance by deeply copying a given ModelObject instance.

Method Summary

Methods

Modifier and Type	Method and Description
ModelObject	clone() Creates and returns a deep copy of this object.
protected JAXBElement	getAnyElement(List<Object> any, String namespaceURI, String localPart) Deprecated. As of JOMC 1.1, please use method getAnyElement(java.util.List, java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.
protected <T> JAXBElement<T>	getAnyElement(List<Object> any, String namespaceURI, String localPart, Class<T> type) Gets a single JAXBElement matching a namespace URI and local part from a given list of objects.
protected List<JAXBElement>	getAnyElements(List<Object> any, String namespaceURI, String localPart) Deprecated. As of JOMC 1.1, please use method getAnyElements(java.util.List, java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.
protected <T> List<JAXBElement<T>>	getAnyElements(List<Object> any, String namespaceURI, String localPart, Class<T> type) Gets a list containing all JAXBElements matching a namespace URI and local part from a given list of objects.
protected <T> T	getAnyObject(List<Object> any, Class<T> clazz) Gets a single object matching a class from a given list of objects.
protected <T> List<T>	getAnyObjects(List<Object> any, Class<T> clazz) Gets a list containing all objects matching a class from a given list of objects.
Authors	getAuthors() Authors of this object or null.
XMLGregorianCalendar	getCreateDate() The date this object got created or null.
Texts	getDocumentation() Documentation of this object or null.
String	getModelVersion() Model version of this object.
boolean	isDeprecated() true, if this object is deprecated.
void	setAuthors(Authors value) Sets the value of the authors property.
void	setCreateDate(XMLGregorianCalendar value) Sets the value of the createDate property.
void	setDeprecated(Boolean value) Sets the value of the deprecated property.
void	setDocumentation(Texts value) Sets the value of the documentation property.
void	setModelVersion(String value) Sets the value of the modelVersion property.

Methods inherited from class java.lang.Object

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

Field Detail

documentation

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Texts documentation

authors

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Authors authors

modelVersion

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String modelVersion

createDate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected XMLGregorianCalendar createDate

deprecated

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Boolean deprecated

MODEL_PUBLIC_ID

public static final String MODEL_PUBLIC_ID

Public identifier of the object management and configuration model.

See Also:

Constant Field Values

Constructor Detail

ModelObject

public ModelObject()

Creates a new ModelObject instance.

ModelObject

public ModelObject(ModelObject o)

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

Parameters:

o - The instance to copy.

Throws:

NullPointerException - if o is null.

Method Detail

getDocumentation

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Texts getDocumentation()

Documentation of this object or null.

Returns:

possible object is Texts

setDocumentation

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setDocumentation(Texts value)

Sets the value of the documentation property.

Parameters:

value - allowed object is Texts

getAuthors

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Authors getAuthors()

Authors of this object or null.

Returns:

possible object is Authors

setAuthors

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setAuthors(Authors value)

Sets the value of the authors property.

Parameters:

value - allowed object is Authors

getModelVersion

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getModelVersion()

Model version of this object.

Returns:

possible object is String

setModelVersion

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setModelVersion(String value)

Sets the value of the modelVersion property.

Parameters:

value - allowed object is String

getCreateDate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public XMLGregorianCalendar getCreateDate()

The date this object got created or null.

Returns:

possible object is XMLGregorianCalendar

setCreateDate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setCreateDate(XMLGregorianCalendar value)

Sets the value of the createDate property.

Parameters:

value - allowed object is XMLGregorianCalendar

isDeprecated

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public boolean isDeprecated()

true, if this object is deprecated.

Returns:

possible object is Boolean

setDeprecated

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setDeprecated(Boolean value)

Sets the value of the deprecated property.

Parameters:

value - allowed object is Boolean

clone

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-04-22T06:46:06+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public ModelObject clone()

Creates and returns a deep copy of this object.

Overrides:

clone in class Object

Returns:

A deep copy of this object.

getAnyElement

@Deprecated
protected JAXBElement getAnyElement(List<Object> any,
                                   String namespaceURI,
                                   String localPart)

Deprecated. As of JOMC 1.1, please use method getAnyElement(java.util.List, 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 a given list of objects.

Parameters:

any - The list to search.

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 list or null if no such element is found.

Throws:

NullPointerException - if any, namespaceURI or localPart is null.

IllegalStateException - if any contains more than one matching element.

getAnyElements

@Deprecated
protected List<JAXBElement> getAnyElements(List<Object> any,
                                          String namespaceURI,
                                          String localPart)

Deprecated. As of JOMC 1.1, please use method getAnyElements(java.util.List, 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 a given list of objects.

Parameters:

any - The list to search.

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 list - an empty list if no such elements are found.

Throws:

NullPointerException - if any, namespaceURI or localPart is null.

getAnyElement

protected <T> JAXBElement<T> getAnyElement(List<Object> any,
                               String namespaceURI,
                               String localPart,
                               Class<T> type)

Gets a single JAXBElement matching a namespace URI and local part from a given list of objects.

Type Parameters:

T - The type the element is bound to.

Parameters:

any - The list to search.

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 list or null if no such element is found.

Throws:

NullPointerException - if any, namespaceURI, localPart or type is null.

IllegalStateException - if any contains more than one matching element.

Since:

1.1

getAnyElements

protected <T> List<JAXBElement<T>> getAnyElements(List<Object> any,
                                      String namespaceURI,
                                      String localPart,
                                      Class<T> type)

Gets a list containing all JAXBElements matching a namespace URI and local part from a given list of objects.

Type Parameters:

T - The type the elements are bound to.

Parameters:

any - The list to search.

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 list - an empty list if no such elements are found.

Throws:

NullPointerException - if any, namespaceURI, localPart or type is null.

Since:

1.1

getAnyObject

protected <T> T getAnyObject(List<Object> any,
                 Class<T> clazz)

Gets a single object matching a class from a given list of objects.

Type Parameters:

T - The type of the object to return.

Parameters:

any - The list to search.

clazz - The class to return an instance of.

Returns:

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

Throws:

NullPointerException - if any or clazz is null.

IllegalStateException - if any contains more than one matching object.

getAnyObjects

protected <T> List<T> getAnyObjects(List<Object> any,
                        Class<T> clazz)

Gets a list containing all objects matching a class from a given list of objects.

Type Parameters:

T - The type of the objects to return.

Parameters:

any - The list to search.

clazz - The class to return all instances of.

Returns:

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

Throws:

NullPointerException - if any or clazz is null.