Package javax.jms

Interface TextMessage

All Superinterfaces:
Message

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
See Also:
  • Method Details

    • setText

      void setText(String string) throws JMSException
      Sets the string containing this message's data.
      Parameters:
      string - the String containing the message's data
      Throws:
      JMSException - if the JMS provider fails to set the text due to some internal error.
      MessageNotWriteableException - if the message is in read-only mode.
    • getText

      String getText() throws JMSException
      Gets the string containing this message's data. The default value is null.
      Returns:
      the String containing the message's data
      Throws:
      JMSException - if the JMS provider fails to get the text due to some internal error.