org.jomc.modlet

Class Service

java.lang.Object

org.jomc.modlet.ModletObject

org.jomc.modlet.Service

All Implemented Interfaces:

Cloneable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public class Service
extends ModletObject
implements Cloneable

Service.

Java class for Service complex type.

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

 <complexType name="Service">
   <complexContent>
     <extension base="{http://jomc.org/modlet}ModletObject">
       <sequence>
         <element name="property" type="{http://jomc.org/modlet}Property" maxOccurs="unbounded" minOccurs="0"/>
         <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="ordinal" type="{http://www.w3.org/2001/XMLSchema}int" default="10000" />
       <attribute name="identifier" use="required" type="{http://jomc.org/modlet}Identifier" />
       <attribute name="class" use="required" type="{http://jomc.org/modlet}Identifier" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Object>	any
protected String	clazz
protected String	identifier
protected Integer	ordinal
protected List<Property>	property

Fields inherited from class org.jomc.modlet.ModletObject

MODEL_PUBLIC_ID, PUBLIC_ID

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Service	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.
String	getClazz() The class providing the service implementation.
String	getIdentifier() The identifier of the service.
int	getOrdinal() The ordinal number of the service.
List<Property>	getProperty() Gets the value of the property property.
void	setClazz(String value) Sets the value of the clazz property.
void	setIdentifier(String value) Sets the value of the identifier property.
void	setOrdinal(Integer value) Sets the value of the ordinal property.

Methods inherited from class org.jomc.modlet.ModletObject

getAnyElement, getAnyElement, getAnyElements, getAnyElements, getAnyObject, getAnyObjects

Methods inherited from class java.lang.Object

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

Field Detail

property

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected List<Property> property

any

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected List<Object> any

ordinal

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Integer ordinal

identifier

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String identifier

clazz

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String clazz

Constructor Detail

Service

public Service()

Creates a new Service instance.

Service

public Service(Service o)

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

Parameters:

o - The instance to copy.

Throws:

NullPointerException - if o is null.

Method Detail

getProperty

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public List<Property> getProperty()

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

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

    getProperty().add(newItem);
 

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

getAny

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+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

getOrdinal

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public int getOrdinal()

The ordinal number of the service.

Returns:

possible object is Integer

setOrdinal

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setOrdinal(Integer value)

Sets the value of the ordinal property.

Parameters:

value - allowed object is Integer

getIdentifier

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getIdentifier()

The identifier of the service.

Returns:

possible object is String

setIdentifier

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setIdentifier(String value)

Sets the value of the identifier property.

Parameters:

value - allowed object is String

getClazz

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getClazz()

The class providing the service implementation.

Returns:

possible object is String

setClazz

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setClazz(String value)

Sets the value of the clazz property.

Parameters:

value - allowed object is String

clone

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:39:30+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Service clone()

Creates and returns a deep copy of this object.

Overrides:

clone in class ModletObject

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:

ModletObject.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:

ModletObject.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:

ModletObject.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:

ModletObject.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:

ModletObject.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:

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