jakarta.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: Jakarta Messaging 2.0
See Also: jakarta.jms.Session#createTextMessage(), jakarta.jms.Session#createTextMessage(String), jakarta.jms.BytesMessage, jakarta.jms.MapMessage, jakarta.jms.Message, jakarta.jms.ObjectMessage, jakarta.jms.StreamMessage, java.lang.String

Field Summary

Inherited from jakarta.jms.Message:: DEFAULT_DELIVERY_DELAY DEFAULT_DELIVERY_MODE DEFAULT_PRIORITY DEFAULT_TIME_TO_LIVE

Method Summary

Modifier and Type	Method 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.

Method Detail

getText back to summary

getText	back 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 Jakarta Messaging provider fails to get the text due to some internal error.

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 Jakarta Messaging provider fails to get the text due to some internal error.

setText back to summary

setText	back 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 Jakarta Messaging provider fails to set the text due to some internal error. MessageNotWriteableException: if the message is in read-only mode.

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 Jakarta Messaging provider fails to set the text due to some internal error.
MessageNotWriteableException:: if the message is in read-only mode.