org.jomc.model
Class Message

Package class diagram package Message
java.lang.Object
  extended by org.jomc.model.ModelObject
      extended by org.jomc.model.Message
All Implemented Interfaces:
Cloneable, Inheritable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public class Message
extends ModelObject
implements Cloneable, Inheritable

Model of a message. The 'Message' type defines attributes 'name', 'final' and 'override'. Attribute 'name' holds a name uniquely identifying the message in a set of messages. Attribute 'final' flags a message the final node in an inheritance hierarchy. Attribute 'override' flags a message as intended to override a super-message. A message defines a localizable template and format arguments.

Java class for Message complex type.

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

 <complexType name="Message">
   <complexContent>
     <extension base="{http://jomc.org/model}ModelObject">
       <sequence>
         <element ref="{http://jomc.org/model}template"/>
         <element ref="{http://jomc.org/model}arguments" 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="final" type="{http://jomc.org/model}Flag" default="false" />
       <attribute name="override" type="{http://jomc.org/model}Flag" default="false" />
     </extension>
   </complexContent>
 </complexType>
 


Field Summary
protected  Boolean _final
           
protected  List<Object> any
           
protected  Arguments arguments
           
protected  String name
           
protected  Boolean override
           
protected  Texts template
           
 
Fields inherited from class org.jomc.model.ModelObject
authors, createDate, deprecated, documentation, MODEL_PUBLIC_ID, modelVersion
 
Constructor Summary
Message()
          Creates a new Message instance.
Message(Message o)
          Creates a new Message instance by deeply copying a given Message instance.
 
Method Summary
 Message 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.
 Arguments getArguments()
          The format arguments of this message or null.
 MessageFormat getJavaMessage(Locale locale)
          Gets a Java MessageFormat instance for a given locale.
 String getName()
          The name of this message.
 Texts getTemplate()
          The localizable template of this message.
 boolean isFinal()
          true, if this message is the final node in an inheritance hierarchy.
 boolean isOverride()
          true, if this message is intended to override a super message.
 void setArguments(Arguments value)
          Sets the value of the arguments property.
 void setFinal(Boolean value)
          Sets the value of the final property.
 void setName(String value)
          Sets the value of the name property.
 void setOverride(Boolean value)
          Sets the value of the override property.
 void setTemplate(Texts value)
          Sets the value of the template 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

template

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Texts template

arguments

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Arguments arguments

any

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+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-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String name

_final

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Boolean _final

override

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Boolean override
Constructor Detail

Message

public Message()
Creates a new Message instance.


Message

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

Parameters:
o - The instance to copy.
Throws:
NullPointerException - if o is null.
Method Detail

getTemplate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Texts getTemplate()
The localizable template of this message.

Returns:
possible object is Texts

setTemplate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setTemplate(Texts value)
Sets the value of the template property.

Parameters:
value - allowed object is Texts

getArguments

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Arguments getArguments()
The format arguments of this message or null.

Returns:
possible object is Arguments

setArguments

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setArguments(Arguments value)
Sets the value of the arguments property.

Parameters:
value - allowed object is Arguments

getAny

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+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-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getName()
The name of this message.

Returns:
possible object is String

setName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+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

isFinal

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public boolean isFinal()
true, if this message is the final node in an inheritance hierarchy.

Specified by:
isFinal in interface Inheritable
Returns:
possible object is Boolean

setFinal

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setFinal(Boolean value)
Sets the value of the final property.

Parameters:
value - allowed object is Boolean

isOverride

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public boolean isOverride()
true, if this message is intended to override a super message.

Specified by:
isOverride in interface Inheritable
Returns:
possible object is Boolean

setOverride

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setOverride(Boolean value)
Sets the value of the override property.

Parameters:
value - allowed object is Boolean

clone

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-04-01T02:39:59+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Message 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)

getJavaMessage

public MessageFormat getJavaMessage(Locale locale)
Gets a Java MessageFormat instance for a given locale.

Parameters:
locale - The locale to get a Java MessageFormat instance for.
Returns:
A Java MessageFormat instance for locale.
Throws:
NullPointerException - if locale is null.
Since:
1.2
See Also:
getTemplate()


Copyright © 2005-2012 The JOMC Project. All Rights Reserved.Get JOMC at SourceForge.net. Fast, secure and Free Open Source software downloads
Please note that this documentation is maintained by non-native english speaking authors. As such, you may encounter phrases or wordings which seem imprecise or may even have a totally different meaning to native english speaking readers than what the individual author was trying to express. If you are a native english speaking reader and find any such phrases or wordings we kindly ask you to send an email to the corresponding author and help us improve this documentation in order to avoid misunderstandings. You will find the authors' email addresses at the top of each class. Please accept our apologies for any inconvenience caused.