org.jomc.model
Class Argument

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

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 Argument
extends ModelObject
implements Cloneable

Model of a message argument. The 'Argument' type defines attributes 'index', 'name' and 'type'. Attribute 'index' holds the index of the argument in a list of arguments. Attribute 'name' holds the name uniquely identifying the argument in a set of arguments. Attribute 'type' holds the type of the argument.

Java class for Argument complex type.

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

 <complexType name="Argument">
   <complexContent>
     <extension base="{http://jomc.org/model}ModelObject">
       <sequence>
         <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="index" use="required" type="{http://jomc.org/model}Index" />
       <attribute name="name" use="required" type="{http://jomc.org/model}Identifier" />
       <attribute name="type" type="{http://jomc.org/model}ArgumentType" default="Text" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

protected List<Object>	any
protected int	index
protected String	name
protected ArgumentType	type

Fields inherited from class org.jomc.model.ModelObject

authors, createDate, deprecated, documentation, MODEL_PUBLIC_ID, modelVersion

Constructor Summary

Argument()
Creates a new Argument instance.

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

Method Summary

Argument	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.
int	getIndex() Index of this argument.
String	getName() Name of this argument.
ArgumentType	getType() Type of this argument.
void	setIndex(int value) Sets the value of the index property.
void	setName(String value) Sets the value of the name property.
void	setType(ArgumentType value) Sets the value of the type 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

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

index

@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 int index

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

type

@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 ArgumentType type

Constructor Detail

Argument

public Argument()

Creates a new Argument instance.

Argument

public Argument(Argument o)

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

Parameters:

o - The instance to copy.

Throws:

NullPointerException - if o is null.

Method Detail

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

getIndex

@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 int getIndex()

Index of this argument.

setIndex

@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 setIndex(int value)

Sets the value of the index property.

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

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

getType

@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 ArgumentType getType()

Type of this argument.

Returns:

possible object is ArgumentType

setType

@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 setType(ArgumentType value)

Sets the value of the type property.

Parameters:

value - allowed object is ArgumentType

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 Argument 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)