org.exolab.jmscts.jms.message
Class BasicTextMessage

java.lang.Object
  |
  +--org.exolab.jmscts.jms.message.BasicMessage
        |
        +--org.exolab.jmscts.jms.message.BasicTextMessage

All Implemented Interfaces:

javax.jms.Message, javax.jms.TextMessage

public class BasicTextMessage

extends BasicMessage

implements javax.jms.TextMessage

This class provides a basic implementation of the javax.jms.ObjectMessage interface.

Version:

$Revision: 1.2 $ $Date: 2004/02/02 03:49:55 $

Author:

Tim Anderson

See Also:

TextMessage

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

BasicTextMessage()
Construct a new BasicTextMessage

Method Summary

void	clearBody() Clear out the message body.
java.lang.String	getText() Get the string containing this message's data.
void	setText(java.lang.String text) Set the text of this message

Methods inherited from class org.exolab.jmscts.jms.message.BasicMessage

acknowledge, checkPropertyWrite, checkRead, checkWrite, clearProperties, getBodyReadOnly, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertiesReadOnly, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBodyReadOnly, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setPropertiesReadOnly, setReadOnly, setShortProperty, setStringProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.jms.Message

acknowledge, clearProperties, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty

Constructor Detail

BasicTextMessage

public BasicTextMessage()

Construct a new BasicTextMessage

Method Detail

setText

public void setText(java.lang.String text)
             throws javax.jms.MessageNotWriteableException

Set the text of this message

Specified by:

setText in interface javax.jms.TextMessage

Parameters:

text - the text to set

Throws:

javax.jms.MessageNotWriteableException - if message in read-only mode

getText

public java.lang.String getText()

Get the string containing this message's data. The default value is null.

Specified by:

getText in interface javax.jms.TextMessage

Returns:

the String containing the message's data

clearBody

public void clearBody()
               throws javax.jms.JMSException

Clear out the message body. Clearing a message's body does not clear its header values or property entries. If this message body was read-only, calling this method leaves the message body is in the same state as an empty body in a newly created message

Specified by:

clearBody in interface javax.jms.Message

Overrides:

clearBody in class BasicMessage

Throws:

javax.jms.JMSException - if the body can't be cleared