|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jomc.model.ModelObject
org.jomc.model.Message
@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
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. |
|
|
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. |
|
|
getAnyElements(String namespaceURI,
String localPart,
Class<T> type)
Gets a list containing all JAXBElement s matching a namespace URI and local part from the any
property of the instance. |
|
|
getAnyObject(Class<T> clazz)
Gets a single object matching a given class from the any property of the instance. |
|
|
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 |
---|
@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
@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
@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
@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
@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
@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 |
---|
public Message()
Message
instance.
public Message(Message o)
Message
instance by deeply copying a given Message
instance.
o
- The instance to copy.
NullPointerException
- if o
is null
.Method Detail |
---|
@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()
Texts
@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)
value
- allowed object is
Texts
@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()
null
.
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") public void setArguments(Arguments value)
value
- allowed object is
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") public List<Object> getAny()
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
@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()
String
@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)
value
- allowed object is
String
@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.
isFinal
in interface Inheritable
Boolean
@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)
value
- allowed object is
Boolean
@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.
isOverride
in interface Inheritable
Boolean
@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)
value
- allowed object is
Boolean
@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()
clone
in class ModelObject
@Deprecated public javax.xml.bind.JAXBElement getAnyElement(String namespaceURI, String localPart)
getAnyElement(java.lang.String, java.lang.String, java.lang.Class)
.
This method will be removed in version 2.0.
JAXBElement
matching a namespace URI and local part from the any
property of the
instance.
namespaceURI
- The namespace URI of the JAXBElement
to return.localPart
- The local part of the JAXBElement
to return.
JAXBElement
matching namespaceURI
and localPart
from the any
property
of the instance or null
, if no such element is found.
NullPointerException
- if namespaceURI
or localPart
is null
.
IllegalStateException
- if the any
property contains more than one matching element.ModelObject.getAnyElement(java.util.List, java.lang.String, java.lang.String)
@Deprecated public List<javax.xml.bind.JAXBElement> getAnyElements(String namespaceURI, String localPart)
getAnyElements(java.lang.String, java.lang.String, java.lang.Class)
.
This method will be removed in version 2.0.
JAXBElement
s matching a namespace URI and local part from the any
property of the instance.
namespaceURI
- The namespace URI of the JAXBElement
s to return.localPart
- The local part of the JAXBElement
s to return.
JAXBElement
s matching namespaceURI
and localPart
from
the any
property of the instance - an empty list if no such elements are found.
NullPointerException
- if namespaceURI
or localPart
is null
.ModelObject.getAnyElements(java.util.List, java.lang.String, java.lang.String)
public <T> javax.xml.bind.JAXBElement<T> getAnyElement(String namespaceURI, String localPart, Class<T> type)
JAXBElement
matching a namespace URI and local part from the any
property of the
instance.
T
- The type the element is bound to.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.
JAXBElement
matching namespaceURI
and localPart
from the any
property
of the instance or null
, if no such element is found.
NullPointerException
- if namespaceURI
, localPart
or type
is null
.
IllegalStateException
- if the any
property contains more than one matching element.ModelObject.getAnyElement(java.util.List, java.lang.String, java.lang.String, java.lang.Class)
public <T> List<javax.xml.bind.JAXBElement<T>> getAnyElements(String namespaceURI, String localPart, Class<T> type)
JAXBElement
s matching a namespace URI and local part from the any
property of the instance.
T
- The type the elements are bound to.namespaceURI
- The namespace URI of the JAXBElement
s to return.localPart
- The local part of the JAXBElement
s to return.type
- The class of the type the elements are bound to.
JAXBElement
s matching namespaceURI
and localPart
from
the any
property of the instance - an empty list if no such elements are found.
NullPointerException
- if namespaceURI
, localPart
or type
is null
.ModelObject.getAnyElements(java.util.List, java.lang.String, java.lang.String, java.lang.Class)
public <T> T getAnyObject(Class<T> clazz)
any
property of the instance.
T
- The type of the object to return.clazz
- The class to return an instance of.
clazz
from the any
property of the instance or null
, if no such
instance is found.
NullPointerException
- if clazz
is null
.
IllegalStateException
- if the any
property contains more than one matching object.ModelObject.getAnyObject(java.util.List, java.lang.Class)
public <T> List<T> getAnyObjects(Class<T> clazz)
any
property of the instance.
T
- The type of the objects to return.clazz
- The class to return all instances of.
clazz
from the any
property of the instance -
an empty list if no such objects are found.
NullPointerException
- if clazz
is null
.ModelObject.getAnyObjects(java.util.List, java.lang.Class)
public MessageFormat getJavaMessage(Locale locale)
MessageFormat
instance for a given locale.
locale
- The locale to get a Java MessageFormat
instance for.
MessageFormat
instance for locale
.
NullPointerException
- if locale
is null
.getTemplate()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2005-2012 The JOMC Project. All Rights Reserved. |