1. /*

  2.  * Copyright 2002 Sun Microsystems, Inc. All rights reserved.

  3.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  4.  */

  5. 

  6. package javax.jms;

  7. 

  8. /** A <CODE>TextMessage</CODE> object is used to send a message containing a 

  9.   * <CODE>java.lang.String</CODE>.

  10.   * It inherits from the <CODE>Message</CODE> interface and adds a text message 

  11.   * body.

  12.   *

  13.   * <P>The inclusion of this message type is based on the presumption 

  14.   * that XML will likely become a popular mechanism for representing 

  15.   * content of all kinds, including the content of JMS messages.

  16.   *

  17.   * <P>When a client receives a <CODE>TextMessage</CODE>, it is in read-only 

  18.   * mode. If a client attempts to write to the message at this point, a 

  19.   * <CODE>MessageNotWriteableException</CODE> is thrown. If 

  20.   * <CODE>clearBody</CODE> is 

  21.   * called, the message can now be both read from and written to.

  22.   *

  23.   * @version     1.0 - 19 March 1998

  24.   * @author      Mark Hapner

  25.   * @author      Rich Burridge

  26.   *

  27.   * @see         javax.jms.Session#createTextMessage()

  28.   * @see         javax.jms.Session#createTextMessage(String)

  29.   * @see         javax.jms.BytesMessage

  30.   * @see         javax.jms.MapMessage

  31.   * @see         javax.jms.Message

  32.   * @see         javax.jms.ObjectMessage

  33.   * @see         javax.jms.StreamMessage

  34.   * @see         java.lang.String

  35.   */

  36.  

  37. public interface TextMessage extends Message { 

  38. 

  39.     /** Sets the string containing this message's data.

  40.       *  

  41.       * @param string the <CODE>String</CODE> containing the message's data

  42.       *  

  43.       * @exception JMSException if the JMS provider fails to set the text due to

  44.       *                         some internal error.

  45.       * @exception MessageNotWriteableException if the message is in read-only 

  46.       *                                         mode.

  47.       */ 

  48. 

  49.     void

  50.     setText(String string) throws JMSException;

  51. 

  52. 

  53.     /** Gets the string containing this message's data.  The default

  54.       * value is null.

  55.       *  

  56.       * @return the <CODE>String</CODE> containing the message's data

  57.       *  

  58.       * @exception JMSException if the JMS provider fails to get the text due to

  59.       *                         some internal error.

  60.       */ 

  61. 

  62.     String

  63.     getText() throws JMSException;

  64. }