org.jdtaus.core.container
Class Message

java.lang.Object
  org.jdtaus.core.container.ModelObject
      org.jdtaus.core.container.Message

All Implemented Interfaces:

Serializable, Cloneable

public class Message
extends ModelObject
implements Cloneable, Serializable

Message meta-data.

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.

Version:

$Id: Message.java 8044 2009-07-02 01:29:05Z schulte2005 $

Author:

Christian Schulte

See Also:

Serialized Form

Constructor Summary

Message()

Method Summary

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object o) Indicates whether some other object is equal to this one by comparing properties name and moduleName.
Arguments	getArguments() Gets the arguments of the message.
String	getModuleName() Gets the name of the module holding the message.
String	getName() Gets the name of the message.
Text	getTemplate() Gets the template of the message.
int	hashCode() Returns a hash code value for this object.
void	setArguments(Arguments value) Setter for property arguments.
void	setModuleName(String value) Setter for property moduleName.
void	setName(String value) Setter for property name.
void	setTemplate(Text value) Setter for property template.
String	toString() Returns a string representation of the object.

Methods inherited from class org.jdtaus.core.container.ModelObject

getDocumentation, getModelVersion, setDocumentation, setModelVersion

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Message

public Message()

Method Detail

clone

public Object clone()

Creates and returns a copy of this object. This method performs a "shallow copy" of this object, not a "deep copy" operation.

Overrides:

clone in class Object

Returns:

a clone of this instance.

equals

public final boolean equals(Object o)

Indicates whether some other object is equal to this one by comparing properties name and moduleName.

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as o; false otherwise.

getArguments

public Arguments getArguments()

Gets the arguments of the message.

Returns:

the arguments of the message.

getModuleName

public String getModuleName()

Gets the name of the module holding the message.

Returns:

the name of the module holding the message.

getName

public String getName()

Gets the name of the message.

Returns:

the name of the message.

getTemplate

public Text getTemplate()

Gets the template of the message.

Returns:

the template of the message.

hashCode

public final int hashCode()

Returns a hash code value for this object.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

setArguments

public void setArguments(Arguments value)

Setter for property arguments.

Parameters:

value - the new arguments of the message.

setModuleName

public void setModuleName(String value)

Setter for property moduleName.

Parameters:

value - the new name of the module holding the message.

setName

public void setName(String value)

Setter for property name.

Parameters:

value - the new name of the message.

setTemplate

public void setTemplate(Text value)

Setter for property template.

Parameters:

value - the new template of the message.

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

Returns:

a string representation of the object.