javax.jms
Interface TextMessage

All Superinterfaces:

Message

All Known Subinterfaces:

JMQXMLMessage

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.

The inclusion of this message type is based on the presumption that XML will likely become a popular mechanism for representing content of all kinds, including the content of JMS messages.

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.

See Also:

Session.createTextMessage(), Session.createTextMessage(String), BytesMessage, MapMessage, Message, ObjectMessage, StreamMessage, String

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

 

Method Summary
String	getText()           Gets the string containing this message's data.
void	setText(String string)           Sets the string containing this message's data.

 

Methods inherited from interface javax.jms.Message

acknowledge, clearBody, clearProperties, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, Method Detail setText public 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 public 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. Overview  Package   Class  Tree  Deprecated  Index  Help  jBroker® MQ 2.1  PREV CLASS   NEXT CLASS FRAMES    NO FRAMES SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD jBroker is a registered trademark of Novell, Inc. Copyright 1998-2003 Novell, Inc. All Rights Reserved.