no.g9.message

Class MessageText

java.lang.Object

no.g9.message.MessageText

All Implemented Interfaces:

Serializable, Cloneable

public class MessageText
extends Object
implements Serializable, Cloneable

Representation of a message text in its various forms...

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MessageText() Default constructor.
MessageText(String text) Constructor for uncached + unparsed MessageTexts.
MessageText(String messageID, String pRawText) Constructor for MessageText identified by number.

Method Summary

Modifier and Type	Method and Description
Object	clone() Makes a copy of this object.
boolean	equals(Object that) Checks equality based on ID.
Object	getId() Returns the ID of this object.
int	hashCode() Returns hash code based on ID.
String	substitute(boolean singleLine, Object[] args) Parses and keeps a substituted string for this text (which is also returned).
String	toString() Returns the "best possible representation" of this object as a String - a substituted string if substitution has been performed, otherwise the raw text (or empty).

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageText

public MessageText()

Default constructor.

MessageText

public MessageText(String messageID,
                   String pRawText)

Constructor for MessageText identified by number.

Parameters:

messageID - message ID for this text

pRawText - Unparsed text

MessageText

public MessageText(String text)

Constructor for uncached + unparsed MessageTexts.

Parameters:

text - The text...

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

Makes a copy of this object. Overrides Object.clone.

Overrides:

clone in class Object

Returns:

A shallow copy of this object

Throws:

CloneNotSupportedException - Never

See Also:

Object.clone()

hashCode

public int hashCode()

Returns hash code based on ID.

Overrides:

hashCode in class Object

Returns:

Hash code

See Also:

Object.clone()

equals

public boolean equals(Object that)

Checks equality based on ID. Overrides Object.equals.

Overrides:

equals in class Object

Parameters:

that - Object to compare to

Returns:

TRUE if objects are Equal

See Also:

Object.equals(java.lang.Object)

getId

public Object getId()

Returns the ID of this object.

Returns:

The ID.

substitute

public String substitute(boolean singleLine,
                         Object[] args)

Parses and keeps a substituted string for this text (which is also returned).

Parameters:

singleLine - As specified in ITextPart.appendPart(StringBuffer, boolean, Object[])

args - Substitution variables

Returns:

Message text.

toString

public String toString()

Returns the "best possible representation" of this object as a String - a substituted string if substitution has been performed, otherwise the raw text (or empty).

Overrides:

toString in class Object

Returns:

This object as a String.