TextMessage

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.jms
Interface TextMessage

All Superinterfaces:: Message (src)

All Known Implementing Classes:: JmsTextMessage (src) , SpyTextMessage (src) , TextMessageImpl (src)

public interface TextMessage
extends Message (src)

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.

See Also:: Session.createTextMessage(), Session.createTextMessage(String), BytesMessage (src) , MapMessage (src) , Message (src) , ObjectMessage (src) , StreamMessage (src) , String

Field Summary

Fields inherited from interface javax.jms.Message (src)

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

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

Methods inherited from interface javax.jms.Message (src)

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, setStringProperty

Method Detail

setText

public void setText(java.lang.String string)
             throws JMSException (src)

Sets the string containing this message's data.

Parameters:: string - the String containing the message's data
Throws:: JMSException (src) - if the JMS provider fails to set the text due to some internal error.; MessageNotWriteableException (src) - if the message is in read-only mode.

getText

public java.lang.String getText()
                         throws JMSException (src)

Gets the string containing this message's data. The default value is null.

Returns:: the String containing the message's data
Throws:: JMSException (src) - if the JMS provider fails to get the text due to some internal error.