org.hornetq.jms.client

Class HornetQTextMessage

java.lang.Object

org.hornetq.jms.client.HornetQMessage

org.hornetq.jms.client.HornetQTextMessage

All Implemented Interfaces:

Message, TextMessage

public class HornetQTextMessage
extends HornetQMessage
implements TextMessage

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

Version:

$Revision: 3412 $ $Id: HornetQRATextMessage.java 3412 2007-12-05 19:41:47Z timfox $

Author:

Norbert Lataille (Norbert.Lataille@m4x.org), Jason Dillon, Adrian Brock, Tim Fox, Ovidiu Feodorov, Andy Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static byte	TYPE

Fields inherited from class org.hornetq.jms.client.HornetQMessage

message, propertiesReadOnly, readOnly

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clearBody() Clears out the message body.
void	doBeforeReceive()
void	doBeforeSend()
String	getText() Gets the string containing this message's data.
byte	getType()
void	setText(String text) Sets the string containing this message's data.

Methods inherited from class org.hornetq.jms.client.HornetQMessage

acknowledge, checkBuffer, checkRead, checkWrite, clearProperties, coreMaptoJMSMap, createMessage, getBooleanProperty, getByteProperty, getCoreMessage, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, resetMessageID, saveToOutputStream, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIndividualAcknowledge, setInputStream, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, 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, 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

Field Detail

TYPE

public static final byte TYPE

See Also:

Constant Field Values

Constructor Detail

HornetQTextMessage

public HornetQTextMessage(ClientSession session)

HornetQTextMessage

public HornetQTextMessage(ClientMessage message,
                  ClientSession session)

HornetQTextMessage

public HornetQTextMessage(TextMessage foreign,
                  ClientSession session)
                   throws JMSException

A copy constructor for non-HornetQ JMS TextMessages.

Throws:

JMSException

Method Detail

getType

public byte getType()

Overrides:

getType in class HornetQMessage

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()
               throws JMSException

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

Throws:

JMSException - if the JMS provider fails to get the text due to some internal error.

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 HornetQMessage

Throws:

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

doBeforeSend

public void doBeforeSend()
                  throws Exception

Overrides:

doBeforeSend in class HornetQMessage

Throws:

Exception

doBeforeReceive

public void doBeforeReceive()
                     throws HornetQException

Overrides:

doBeforeReceive in class HornetQMessage

Throws:

HornetQException