Package org.apache.qpid.jms.message.facade

Interface JmsTextMessageFacade

All Superinterfaces:

JmsMessageFacade, TraceableMessage

All Known Implementing Classes:

AmqpJmsTextMessageFacade

public interface JmsTextMessageFacade
extends JmsMessageFacade

A Facade around a provider message that behaves like a TextMessage instance.

Method Summary

Modifier and Type	Method	Description
JmsTextMessageFacade	copy()	Creates a copy of this JmsTextMessageFacade and its underlying provider message instance.
String	getText()	Returns the String payload of the Message or null if none set.
void	setText(String value)	Sets the new String payload of the wrapped message, or clears the old value if the given value is null.

Methods inherited from interface org.apache.qpid.jms.message.facade.JmsMessageFacade

clearBody, clearProperties, encodeMessage, getCorrelationId, getCorrelationIdBytes, getDeliveryCount, getDeliveryTime, getDestination, getExpiration, getGroupId, getGroupSequence, getMessageId, getPriority, getProperty, getPropertyNames, getProviderMessageIdObject, getRedeliveryCount, getReplyTo, getTimestamp, getType, getUserId, getUserIdBytes, hasBody, isDeliveryTimeTransmitted, isPersistent, isRedelivered, onDispatch, onSend, propertyExists, setCorrelationId, setCorrelationIdBytes, setDeliveryCount, setDeliveryTime, setDestination, setExpiration, setGroupId, setGroupSequence, setMessageId, setPersistent, setPriority, setProperty, setProviderMessageIdObject, setRedelivered, setRedeliveryCount, setReplyTo, setTimestamp, setType, setUserId, setUserIdBytes

Methods inherited from interface org.apache.qpid.jms.tracing.TraceableMessage

filterTracingAnnotations, getTracingAnnotation, getTracingContext, removeTracingAnnotation, removeTracingContext, setTracingAnnotation, setTracingContext

Method Details

copy

JmsTextMessageFacade copy()
                   throws jakarta.jms.JMSException

Creates a copy of this JmsTextMessageFacade and its underlying provider message instance.

Specified by:

copy in interface JmsMessageFacade

Returns:

a new JmsTextMessageFacade that wraps a duplicate message.

Throws:

jakarta.jms.JMSException - if an error occurs while copying the message.

getText

String getText()
        throws jakarta.jms.JMSException

Returns the String payload of the Message or null if none set.

Returns:

the String value contained in the message.

Throws:

jakarta.jms.JMSException - if an error occurs while decoding text payload.

setText

void setText(String value)

Sets the new String payload of the wrapped message, or clears the old value if the given value is null.

Parameters:

value - the new String payload, or null to clear the contents.