ie.ncl.msg
Class TextMessage

java.lang.Object
  ie.ncl.msg.Message
      ie.ncl.msg.TextMessage

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

EmailMessage

public class TextMessage
extends Message

TextMessage extends the base class Message (used for all messages in the Generic API) by implementing the message body textual (String) data.

See Also:

Serialized Form

Constructor Summary

TextMessage()
Constructs a blank text message.

TextMessage(Address address, java.lang.String text)
Construct a new text message.

TextMessage(Message m)
Construct a new text message from an existing base class one.

TextMessage(TextMessage m)
Construct a new text message from an existing one.

Method Summary

java.lang.Object	getBody() Get the message body.
java.lang.String	getText() Get the text of the message.
int	length() Get the length of the text body.
void	setBody(java.lang.Object body) Set the message body.
void	setText(java.lang.String text) Set the text of the message.

Methods inherited from class ie.ncl.msg.Message

getAttribute, getAttributes, getCorrelationID, getDestination, getID, getSource, getType, putAttribute, removeAttribute, setAttributes, setCorrelationID, setDestination, setID, setSource, setType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextMessage

public TextMessage()

Constructs a blank text message.

TextMessage

public TextMessage(Address address,
                   java.lang.String text)

Construct a new text message.

TextMessage

public TextMessage(TextMessage m)

Construct a new text message from an existing one. All message data is copied EXCEPT the correlation ID and the message ID. The attribute set of the message is also cloned/copied (not referenced).

See Also:

Message.Message(Message), Attributes.copy()

TextMessage

public TextMessage(Message m)

Construct a new text message from an existing base class one. All message data is copied EXCEPT the correlation ID and the message ID and Text is null. The attribute set of the message is also cloned/copied (not referenced).

See Also:

Message.Message(Message), Attributes.copy()

Method Detail

getText

public java.lang.String getText()

Get the text of the message.

setText

public void setText(java.lang.String text)

Set the text of the message.

getBody

public java.lang.Object getBody()

Get the message body. The body object for this class is a String.

Specified by:

getBody in class Message

setBody

public void setBody(java.lang.Object body)

Set the message body. The body object for this class is a String.

Specified by:

setBody in class Message

length

public int length()

Get the length of the text body.