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-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public class Message
extends ModelObject
implements Cloneable

Model of a message.

A message consists of the properties name, template and arguments. Property name holds a name uniquely identifying the message in a set of messages. Property template holds the template of the message. Property arguments holds meta-data describing arguments to format the message with.


Field Summary
protected  List<Object> any
           
protected  Arguments arguments
           
protected  String name
           
protected  Texts template
           
 
Fields inherited from class org.jomc.model.ModelObject
authors, createDate, documentation, modelVersion
 
Constructor Summary
Message()
          Creates a new Message instance.
Message(Message o)
          Creates a new Message instance by deeply copying a given instance.
 
Method Summary
 Message clone()
          Creates and returns a deep copy of this object.
private static void copyAny(List<Object> source, List<Object> target)
          Copies all values of property Any deeply.
private static boolean[] copyOf(boolean[] array)
          Creates and returns a deep copy of a given array.
private static byte[] copyOf(byte[] array)
          Creates and returns a deep copy of a given array.
private static char[] copyOf(char[] array)
          Creates and returns a deep copy of a given array.
private static double[] copyOf(double[] array)
          Creates and returns a deep copy of a given array.
private static float[] copyOf(float[] array)
          Creates and returns a deep copy of a given array.
private static int[] copyOf(int[] array)
          Creates and returns a deep copy of a given array.
private static long[] copyOf(long[] array)
          Creates and returns a deep copy of a given array.
private static short[] copyOf(short[] array)
          Creates and returns a deep copy of a given array.
private static Object copyOfArray(Object array)
          Creates and returns a deep copy of a given array.
private static JAXBElement copyOFJAXBElement(JAXBElement element)
          Creates and returns a deep copy of a given JAXBElement instance.
private static Object copyOfObject(Object o)
          Creates and returns a deep copy of a given object.
private static Serializable copyOfSerializable(Serializable serializable)
          Creates and returns a deep copy of a given Serializable.
 List<Object> getAny()
          Gets the value of the any property.
 Arguments getArguments()
          The arguments of this message.
 String getName()
          The name of this message.
 Texts getTemplate()
          The template of this message.
 void setArguments(Arguments value)
          Sets the value of the arguments property.
 void setName(String value)
          Sets the value of the name property.
 void setTemplate(Texts value)
          Sets the value of the template property.
 
Methods inherited from class org.jomc.model.ModelObject
getAuthors, getCreateDate, getDocumentation, getModelVersion, setAuthors, setCreateDate, 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-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
protected Texts template

arguments

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
protected Arguments arguments

any

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+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-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
protected String name
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 instance.

Parameters:
o - The instance to copy or null.
Method Detail

getTemplate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public Texts getTemplate()
The template of this message.

Returns:
possible object is Texts

setTemplate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+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-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public Arguments getArguments()
The arguments of this message.

Returns:
possible object is Arguments

setArguments

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+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-09-21T10:35:38+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-09-21T10:35:38+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-09-21T10:35:38+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

copyAny

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static void copyAny(List<Object> source,
                                                       List<Object> target)
Copies all values of property Any deeply.

Parameters:
target - The target to copy source to.
source - The source to copy from.
Throws:
NullPointerException - if source or target is null.

copyOfObject

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static Object copyOfObject(Object o)
Creates and returns a deep copy of a given object.

Parameters:
o - The instance to copy or null.
Returns:
A deep copy of o or null if o is null.

copyOfArray

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static Object copyOfArray(Object array)
Creates and returns a deep copy of a given array.

Parameters:
array - The array to copy or null.
Returns:
A deep copy of array or null if array is null.

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static boolean[] copyOf(boolean[] array)
Creates and returns a deep copy of a given array.

Parameters:
array - The array to copy or null.
Returns:
A deep copy of array or null if array is null.

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static byte[] copyOf(byte[] array)
Creates and returns a deep copy of a given array.

Parameters:
array - The array to copy or null.
Returns:
A deep copy of array or null if array is null.

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static char[] copyOf(char[] array)
Creates and returns a deep copy of a given array.

Parameters:
array - The array to copy or null.
Returns:
A deep copy of array or null if array is null.

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static double[] copyOf(double[] array)
Creates and returns a deep copy of a given array.

Parameters:
array - The array to copy or null.
Returns:
A deep copy of array or null if array is null.

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static float[] copyOf(float[] array)
Creates and returns a deep copy of a given array.

Parameters:
array - The array to copy or null.
Returns:
A deep copy of array or null if array is null.

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static int[] copyOf(int[] array)
Creates and returns a deep copy of a given array.

Parameters:
array - The array to copy or null.
Returns:
A deep copy of array or null if array is null.

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static long[] copyOf(long[] array)
Creates and returns a deep copy of a given array.

Parameters:
array - The array to copy or null.
Returns:
A deep copy of array or null if array is null.

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static short[] copyOf(short[] array)
Creates and returns a deep copy of a given array.

Parameters:
array - The array to copy or null.
Returns:
A deep copy of array or null if array is null.

copyOFJAXBElement

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static JAXBElement copyOFJAXBElement(JAXBElement element)
Creates and returns a deep copy of a given JAXBElement instance.

Parameters:
element - The instance to copy or null.
Returns:
A deep copy of element or null if element is null.

copyOfSerializable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
private static Serializable copyOfSerializable(Serializable serializable)
Creates and returns a deep copy of a given Serializable.

Parameters:
serializable - The instance to copy or null.
Returns:
A deep copy of serializable or null if serializable is null.

clone

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-09-21T10:35:38+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.