Class ActiveMQTextMessage

java.lang.Object

org.apache.activemq.artemis.jms.client.ActiveMQMessage

org.apache.activemq.artemis.jms.client.ActiveMQTextMessage

All Implemented Interfaces:

jakarta.jms.Message, jakarta.jms.TextMessage

Direct Known Subclasses:

ActiveMQTextCompatibleMessage

public class ActiveMQTextMessage
extends ActiveMQMessage
implements jakarta.jms.TextMessage

Apache Artemis implementation of a JMS TextMessage.

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	TYPE

Fields inherited from class ActiveMQMessage

message, OLD_QUEUE_QUALIFIED_PREFIX, OLD_TEMP_QUEUE_QUALIFED_PREFIX, OLD_TEMP_TOPIC_QUALIFED_PREFIX, OLD_TOPIC_QUALIFIED_PREFIX, propertiesReadOnly, readOnly, replyTo

Fields inherited from interface jakarta.jms.Message

DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor	Description
ActiveMQTextMessage(jakarta.jms.TextMessage foreign, org.apache.activemq.artemis.api.core.client.ClientSession session)	A copy constructor for non-Apache Artemis JMS TextMessages.
ActiveMQTextMessage(org.apache.activemq.artemis.api.core.client.ClientMessage message, org.apache.activemq.artemis.api.core.client.ClientSession session)
ActiveMQTextMessage(org.apache.activemq.artemis.api.core.client.ClientSession session)

Method Summary

Modifier and Type	Method	Description
void	clearBody()
void	doBeforeReceive()
protected <T> T	getBodyInternal(Class<T> c)
String	getText()
byte	getType()
boolean	isBodyAssignableTo(Class c)	From the specs:
void	setText(String text)

Methods inherited from class ActiveMQMessage

acknowledge, checkBuffer, checkPrefix, checkPrefixStr, checkRead, checkWrite, clearProperties, coreCompositeTypeToJMSCompositeType, coreMaptoJMSMap, createMessage, createMessage, doBeforeSend, getBody, getBooleanProperty, getByteProperty, getCoreMessage, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, hasNoBody, prefixOf, propertyExists, resetMessageID, saveToOutputStream, setBooleanProperty, setByteProperty, setClientAcknowledge, setDoubleProperty, setFloatProperty, setIndividualAcknowledge, setInputStream, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setOutputStream, setShortProperty, setStringProperty, toString, waitCompletionOnStream

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jakarta.jms.Message

acknowledge, clearProperties, getBody, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty

Field Details

TYPE

public static final byte TYPE

See Also:

• Constant Field Values

Constructor Details

ActiveMQTextMessage

public ActiveMQTextMessage(org.apache.activemq.artemis.api.core.client.ClientSession session)

ActiveMQTextMessage

public ActiveMQTextMessage(org.apache.activemq.artemis.api.core.client.ClientMessage message,
 org.apache.activemq.artemis.api.core.client.ClientSession session)

ActiveMQTextMessage

public ActiveMQTextMessage(jakarta.jms.TextMessage foreign,
 org.apache.activemq.artemis.api.core.client.ClientSession session)
                    throws jakarta.jms.JMSException

A copy constructor for non-Apache Artemis JMS TextMessages.

Throws:

jakarta.jms.JMSException

Method Details

getType

public byte getType()

Overrides:

getType in class ActiveMQMessage

setText

public void setText(String text)
             throws jakarta.jms.JMSException

Specified by:

setText in interface jakarta.jms.TextMessage

Throws:

jakarta.jms.JMSException

getText

public String getText()

Specified by:

getText in interface jakarta.jms.TextMessage

clearBody

public void clearBody()
               throws jakarta.jms.JMSException

Specified by:

clearBody in interface jakarta.jms.Message

Overrides:

clearBody in class ActiveMQMessage

Throws:

jakarta.jms.JMSException

doBeforeReceive

public void doBeforeReceive()
                     throws org.apache.activemq.artemis.api.core.ActiveMQException

Overrides:

doBeforeReceive in class ActiveMQMessage

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

getBodyInternal

protected <T> T getBodyInternal(Class<T> c)

Overrides:

getBodyInternal in class ActiveMQMessage

isBodyAssignableTo

public boolean isBodyAssignableTo(Class c)

Description copied from class: ActiveMQMessage

From the specs:

If the message is a Message (but not one of its subtypes) then this method will return true irrespective of the value of this parameter.

Specified by:

isBodyAssignableTo in interface jakarta.jms.Message

Overrides:

isBodyAssignableTo in class ActiveMQMessage