org.jomc.modlet

Class Property

java.lang.Object

org.jomc.modlet.ModletObject

org.jomc.modlet.Property

All Implemented Interfaces:

Cloneable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-01T05:41:23+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public class Property
extends ModletObject
implements Cloneable

Property.

Java class for Property complex type.

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

 <complexType name="Property">
   <complexContent>
     <extension base="{http://jomc.org/modlet}ModletObject">
       <sequence>
         <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="name" use="required" type="{http://jomc.org/modlet}Identifier" />
       <attribute name="value" type="{http://jomc.org/modlet}String" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Object>	any
protected String	name
protected String	value

Fields inherited from class org.jomc.modlet.ModletObject

MODEL_PUBLIC_ID, PUBLIC_ID

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Property	clone() Creates and returns a deep copy of this object.
List<Object>	getAny() Gets the value of the any property.
<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.
<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	getName() The name of the property.
String	getValue() The value of the property.
void	setName(String value) Sets the value of the name property.
void	setValue(String value) Sets the value of the value 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

any

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-01T05:41:23+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected List<Object> any

name

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-01T05:41:23+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String name

value

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-01T05:41:23+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String value

Constructor Detail

Property

public Property()

Creates a new Property instance.

Property

public Property(Property o)

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

Parameters:

o - The instance to copy.

Throws:

NullPointerException - if o is null.

Method Detail

getAny

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-01T05:41:23+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="2016-09-01T05:41:23+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getName()

The name of the property.

Returns:

possible object is String

setName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-01T05:41:23+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

getValue

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-01T05:41:23+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getValue()

The value of the property.

Returns:

possible object is String

setValue

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-01T05:41:23+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setValue(String value)

Sets the value of the value property.

Parameters:

value - allowed object is String

clone

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-01T05:41:23+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Property clone()

Creates and returns a deep copy of this object.

Overrides:

clone in class ModletObject

Returns:

A deep copy of this object.

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.2

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.2

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)