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

Interface JmsMapMessageFacade

All Superinterfaces:

JmsMessageFacade, TraceableMessage

All Known Implementing Classes:

AmqpJmsMapMessageFacade

public interface JmsMapMessageFacade
extends JmsMessageFacade

Interface for a message Facade that wraps a MapMessage style provider message.

Method Summary

Modifier and Type	Method	Description
JmsMapMessageFacade	copy()	Create a new instance and perform a deep copy of this object's contents.
Object	get(String key)	Gets the value stored in the Map at the specified key.
Enumeration<String>	getMapNames()	Returns an Enumeration of all the names in the MapMessage object.
boolean	itemExists(String key)	Determines whether an item exists in this Map based message.
void	put(String key, Object value)	Sets an object value with the specified name into the Map.
Object	remove(String key)	Remove the mapping for this key from the map if present.

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

JmsMapMessageFacade copy()
                  throws jakarta.jms.JMSException

Description copied from interface: JmsMessageFacade

Create a new instance and perform a deep copy of this object's contents.

Specified by:

copy in interface JmsMessageFacade

Returns:

a deep copy of this Message Facade including a complete copy of the byte contents of the wrapped message.

Throws:

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

getMapNames

Enumeration<String> getMapNames()

Returns an Enumeration of all the names in the MapMessage object.

Returns:

an enumeration of all the names in this MapMessage

itemExists

boolean itemExists(String key)

Determines whether an item exists in this Map based message.

Parameters:

key - The entry key that is being searched for.

Returns:

true if the item exists in the Map, false otherwise.

get

Object get(String key)

Gets the value stored in the Map at the specified key.

Parameters:

key - the key to use to access a value in the Map.

Returns:

the item associated with the given key, or null if not present.

put

void put(String key,
 Object value)

Sets an object value with the specified name into the Map. If a previous mapping for the key exists, the old value is replaced by the specified value. If the value provided is a byte[] its entry then it is assumed that it was copied by the caller and its value will not be altered by the provider.

Parameters:

key - the key to use to store the value into the Map.

value - the new value to store in the element defined by the key.

remove

Object remove(String key)

Remove the mapping for this key from the map if present. If the value is not present in the map then this method should return without error or modification to the underlying map.

Parameters:

key - the key to be removed from the map if present.

Returns:

the object previously stored in the Map or null if none present.