javax.jms
Interface TextMessage
- All Superinterfaces:
- Message
- public interface TextMessage
- extends Message
A TextMessage is used to send a message containing a
java.lang.String
.
It inherits from Message
and adds a text message body.
The inclusion of this message type is based on our 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
Method Summary |
String |
getText()
Get the string containing this message's data. |
void |
setText(String string)
Set 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, setStringProperty |
setText
public void setText(String string)
throws JMSException
- Set the string containing this message's data.
- Parameters:
string
- the String containing the message's data- Throws:
JMSException
- if JMS fails to set text due to
some internal JMS error.MessageNotWriteableException
- if message in read-only mode.
getText
public String getText()
throws JMSException
- Get the string containing this message's data. The default
value is null.
- Returns:
- the String containing the message's data
- Throws:
JMSException
- if JMS fails to get text due to
some internal JMS error.