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

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public class Message
extends ModelObject
implements Cloneable

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, 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.
 Arguments getArguments()
          The format arguments of this message or null.
 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
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="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
protected Texts template

arguments

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
protected Arguments arguments

any

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
protected List<Object> any

name

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
protected String name

_final

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
protected Boolean _final

override

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public Texts getTemplate()
The localizable template of this message.

Returns:
possible object is Texts

setTemplate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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 Element Object


getName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public String getName()
The name of this message.

Returns:
possible object is String

setName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public boolean isFinal()
true if this message is the final node in an inheritance hierarchy.

Returns:
possible object is Boolean

setFinal

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public boolean isOverride()
true if this message is intended to override a super message.

Returns:
possible object is Boolean

setOverride

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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="2009-12-07T03:06:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public Message clone()
Creates and returns a deep copy of this object.

Overrides:
clone in class ModelObject
Returns:
A deep copy of this object.


Copyright © 2005-2009 The JOMC Project. All Rights Reserved.