javax.jms.TextMessage Maven / Gradle / Ivy
/*
* @(#)TextMessage.java 1.17 02/04/09
*
* Copyright 1997-2002 Sun Microsystems, Inc. All Rights Reserved.
*
* SUN PROPRIETARY/CONFIDENTIAL.
* This software is the proprietary information of Sun Microsystems, Inc.
* Use is subject to license terms.
*
*/
package javax.jms;
/** 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
*/
public interface TextMessage extends Message {
/** 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.
*/
void
setText(String string) throws JMSException;
/** 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.
*/
String
getText() throws JMSException;
}