File Doc Category Size Date Package
TextMessage.java API Doc Glassfish v2 API 3995 Fri May 04 22:36:16 BST 2007 javax.jms

TextMessage

public interface TextMessage implements 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.

version: 1.1 - February 2, 2002
author: Mark Hapner
author: Rich Burridge
author: Kate Stout
see: javax.jms.Session#createTextMessage()
see: javax.jms.Session#createTextMessage(String)
see: javax.jms.BytesMessage
see: javax.jms.MapMessage
see: javax.jms.Message
see: javax.jms.ObjectMessage
see: javax.jms.StreamMessage
see: java.lang.String

Fields Summary
Constructors Summary
Methods Summary
public java.lang.String getText()
Gets the string containing this message's data. The default value is null.
return
the String containing the message's data
exception
JMSException if the JMS provider fails to get the text due to some internal error.
public void setText(java.lang.String string)
Sets the string containing this message's data.
param
string the String containing the message's data
exception
JMSException if the JMS provider fails to set the text due to some internal error.
exception
MessageNotWriteableException if the message is in read-only mode.