Top Description Fields Methods
javax.jms

public Interface TextMessage

extends Message
A TextMessage object is used to send a message containing a java.lang.String. It inherits from the Message interface and adds a text message body.

This message type can be used to transport text-based messages, including those with XML content.

When a client receives a TextMessage, it is in read-only mode. If a client attempts to write to the message at this point, a MessageNotWriteableException is thrown. If clearBody is called, the message can now be both read from and written to.

Since
JMS 1.0
Version
JMS 2.0
See Also
javax.jms.Session#createTextMessage(), javax.jms.Session#createTextMessage(String), javax.jms.BytesMessage, javax.jms.MapMessage, javax.jms.Message, javax.jms.ObjectMessage, javax.jms.StreamMessage, java.lang.String

Field Summary

Inherited from javax.jms.Message:
DEFAULT_DELIVERY_DELAYDEFAULT_DELIVERY_MODEDEFAULT_PRIORITYDEFAULT_TIME_TO_LIVE

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the String containing the message's data
getText()

Gets the string containing this message's data.

public void
setText(String
the String containing the message's data
string)

Sets the string containing this message's data.

Inherited from javax.jms.Message:
acknowledgeclearBodyclearPropertiesgetBodygetBooleanPropertygetBytePropertygetDoublePropertygetFloatPropertygetIntPropertygetJMSCorrelationIDgetJMSCorrelationIDAsBytesgetJMSDeliveryModegetJMSDeliveryTimegetJMSDestinationgetJMSExpirationgetJMSMessageIDgetJMSPrioritygetJMSRedeliveredgetJMSReplyTogetJMSTimestampgetJMSTypegetLongPropertygetObjectPropertygetPropertyNamesgetShortPropertygetStringPropertyisBodyAssignableTopropertyExistssetBooleanPropertysetBytePropertysetDoublePropertysetFloatPropertysetIntPropertysetJMSCorrelationIDsetJMSCorrelationIDAsBytessetJMSDeliveryModesetJMSDeliveryTimesetJMSDestinationsetJMSExpirationsetJMSMessageIDsetJMSPrioritysetJMSRedeliveredsetJMSReplyTosetJMSTimestampsetJMSTypesetLongPropertysetObjectPropertysetShortPropertysetStringProperty

Method Detail

getTextback to summary
public String getText() throws JMSException

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

Returns:String

the String containing the message's data

Exceptions
JMSException:
if the JMS provider fails to get the text due to some internal error.
setTextback to summary
public void setText(String string) throws JMSException

Sets the string containing this message's data.

Parameters
string:String

the String containing the message's data

Exceptions
JMSException:
if the JMS provider fails to set the text due to some internal error.
MessageNotWriteableException:
if the message is in read-only mode.