-
- All Superinterfaces:
- Message
public interface TextMessage extends Message
ATextMessageobject is used to send a message containing ajava.lang.String. It inherits from theMessageinterface 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, aMessageNotWriteableExceptionis thrown. IfclearBodyis called, the message can now be both read from and written to.- Since:
- JMS 1.0
- Version:
- JMS 2.0
- See Also:
Session.createTextMessage(),Session.createTextMessage(String),BytesMessage,MapMessage,Message,ObjectMessage,StreamMessage,String
-
-
Field Summary
-
Fields inherited from interface javax.jms.Message
DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description StringgetText()Gets the string containing this message's data.voidsetText(String string)Sets the string containing this message's data.-
Methods inherited from interface javax.jms.Message
acknowledge, clearBody, clearProperties, getBody, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, isBodyAssignableTo, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty
-
-
-
-
Method Detail
-
setText
void setText(String string) throws JMSException
Sets the string containing this message's data.- Parameters:
string- theStringcontaining 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
String getText() throws JMSException
Gets the string containing this message's data. The default value is null.- Returns:
- the
Stringcontaining the message's data - Throws:
JMSException- if the JMS provider fails to get the text due to some internal error.
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/jms/TextMessage.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.