org.apache.activemq.artemis.jms.client

Class ActiveMQTextMessage

java.lang.Object

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

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

All Implemented Interfaces:

Message, TextMessage

public class ActiveMQTextMessage
extends ActiveMQMessage
implements TextMessage

ActiveMQ Artemis implementation of a JMS TextMessage.
This class was ported from SpyTextMessage in JBossMQ.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	TYPE

Fields inherited from class org.apache.activemq.artemis.jms.client.ActiveMQMessage

message, propertiesReadOnly, readOnly

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor and Description
ActiveMQTextMessage(ClientMessage message, ClientSession session)
ActiveMQTextMessage(ClientSession session)
ActiveMQTextMessage(TextMessage foreign, ClientSession session) A copy constructor for non-ActiveMQ Artemis JMS TextMessages.

Method Summary

Modifier and Type	Method and Description
void	clearBody() Clears out the message body.
void	doBeforeReceive()
protected <T> T	getBodyInternal(Class<T> c)
String	getText() Gets the string containing this message's data.
byte	getType()
boolean	isBodyAssignableTo(Class c) Returns whether the message body is capable of being assigned to the specified type.
void	setText(String text) Sets the string containing this message's data.

Methods inherited from class org.apache.activemq.artemis.jms.client.ActiveMQMessage

acknowledge, checkBuffer, 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, propertyExists, resetMessageID, saveToOutputStream, setBooleanProperty, setByteProperty, 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 java.lang.Object

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

Methods inherited from interface javax.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 Detail

TYPE

public static final byte TYPE

See Also:

Constant Field Values

Constructor Detail

ActiveMQTextMessage

public ActiveMQTextMessage(ClientSession session)

ActiveMQTextMessage

public ActiveMQTextMessage(ClientMessage message,
                           ClientSession session)

ActiveMQTextMessage

public ActiveMQTextMessage(TextMessage foreign,
                           ClientSession session)
                    throws JMSException

A copy constructor for non-ActiveMQ Artemis JMS TextMessages.

Throws:

JMSException

Method Detail

getType

public byte getType()

Overrides:

getType in class ActiveMQMessage

setText

public void setText(String text)
             throws JMSException

Description copied from interface: TextMessage

Sets the string containing this message's data.

Specified by:

setText in interface TextMessage

Parameters:

text - 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()

Description copied from interface: TextMessage

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

Specified by:

getText in interface TextMessage

Returns:

the String containing the message's data

clearBody

public void clearBody()
               throws JMSException

Description copied from interface: Message

Clears out the message body. Clearing a message's body does not clear its header values or property entries.

If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.

Specified by:

clearBody in interface Message

Overrides:

clearBody in class ActiveMQMessage

Throws:

JMSException - if the JMS provider fails to clear the message body due to some internal error.

doBeforeReceive

public void doBeforeReceive()
                     throws ActiveMQException

Overrides:

doBeforeReceive in class ActiveMQMessage

Throws:

ActiveMQException

getBodyInternal

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

Overrides:

getBodyInternal in class ActiveMQMessage

isBodyAssignableTo

public boolean isBodyAssignableTo(Class c)

Description copied from interface: Message

Returns whether the message body is capable of being assigned to the specified type. If this method returns true then a subsequent call to the method getBody on the same message with the same type argument would not throw a MessageFormatException.

If the message is a StreamMessage then false is always returned. If the message is a ObjectMessage and object deserialization fails then false is returned. If the message has no body then any type may be specified and true is returned.

Specified by:

isBodyAssignableTo in interface Message

Overrides:

isBodyAssignableTo in class ActiveMQMessage

Parameters:

c - The specified type
If the message is a TextMessage then this method will only return true if this parameter is set to String.class or another type to which a String is assignable.
If the message is a ObjectMessage then this method will only return true if this parameter is set to java.io.Serializable.class or another class to which the body is assignable.
If the message is a MapMessage then this method will only return true if this parameter is set to java.util.Map.class (or java.lang.Object.class).
If the message is a BytesMessage then this this method will only return true if this parameter is set to byte[].class (or java.lang.Object.class).
If the message is a TextMessage, ObjectMessage, MapMessage or BytesMessage and the message has no body, then the above does not apply and this method will return true irrespective of the value of this parameter.
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.

Returns:

whether the message body is capable of being assigned to the specified type