javax.jms
Interface MapMessage

public interface MapMessage

extends Message

A MapMessage is used to send a set of name-value pairs where names are Strings and values are Java primitive types. The entries can be accessed sequentially or randomly by name. The order of the entries is undefined. It inherits from Message and adds a map message body.

The primitive types can be read or written explicitly using methods for each type. They may also be read or written generically as objects. For instance, a call to MapMessage.setInt("foo", 6) is equivalent to MapMessage.setObject("foo", new Integer(6)). Both forms are provided because the explicit form is convenient for static programming and the object form is needed when types are not known at compile time.

When a client receives a MapMessage, it is in read-only mode. If a client attempts to write to the message at this point, a MessageNotWriteableException is thrown. If clearBody is called, the message can now be both read from and written to.

Map messages support the following conversion table. The marked cases must be supported. The unmarked cases must throw a JMSException. The String to primitive conversions may throw a runtime exception if the primitives valueOf() method does not accept it as a valid String representation of the primitive.

A value written as the row type can be read as the column type.

 |        | boolean byte short char int long float double String byte[]
 |----------------------------------------------------------------------
 |boolean |    X                                            X
 |byte    |          X     X         X   X                  X
 |short   |                X         X   X                  X
 |char    |                     X                           X
 |int     |                          X   X                  X
 |long    |                              X                  X
 |float   |                                    X     X      X
 |double  |                                          X      X
 |String  |    X     X     X         X   X     X     X      X
 |byte[]  |                                                        X
 |----------------------------------------------------------------------
 

Attempting to read a null value as a Java primitive type must be treated as calling the primitive's corresponding valueOf(String) conversion method with a null value. Since char does not support a String conversion, attempting to read a null value as a char must throw NullPointerException.

See Also:

Session.createMapMessage(), BytesMessage, Message, ObjectMessage, StreamMessage, TextMessage

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Method Summary

boolean	getBoolean(java.lang.String name) Return the boolean value with the given name.
byte	getByte(java.lang.String name) Return the byte value with the given name.
byte[]	getBytes(java.lang.String name) Return the byte array value with the given name.
char	getChar(java.lang.String name) Return the Unicode character value with the given name.
double	getDouble(java.lang.String name) Return the double value with the given name.
float	getFloat(java.lang.String name) Return the float value with the given name.
int	getInt(java.lang.String name) Return the integer value with the given name.
long	getLong(java.lang.String name) Return the long value with the given name.
java.util.Enumeration	getMapNames() Return an Enumeration of all the Map message's names.
java.lang.Object	getObject(java.lang.String name) Return the Java object value with the given name.
short	getShort(java.lang.String name) Return the short value with the given name.
java.lang.String	getString(java.lang.String name) Return the String value with the given name.
boolean	itemExists(java.lang.String name) Check if an item exists in this MapMessage.
void	setBoolean(java.lang.String name, boolean value) Set a boolean value with the given name, into the Map.
void	setByte(java.lang.String name, byte value) Set a byte value with the given name, into the Map.
void	setBytes(java.lang.String name, byte[] value) Set a byte array value with the given name, into the Map.
void	setBytes(java.lang.String name, byte[] value, int offset, int length) Set a portion of the byte array value with the given name, into the Map.
void	setChar(java.lang.String name, char value) Set a Unicode character value with the given name, into the Map.
void	setDouble(java.lang.String name, double value) Set a double value with the given name, into the Map.
void	setFloat(java.lang.String name, float value) Set a float value with the given name, into the Map.
void	setInt(java.lang.String name, int value) Set an integer value with the given name, into the Map.
void	setLong(java.lang.String name, long value) Set a long value with the given name, into the Map.
void	setObject(java.lang.String name, java.lang.Object value) Set a Java object value with the given name, into the Map.
void	setShort(java.lang.String name, short value) Set a short value with the given name, into the Map.
void	setString(java.lang.String name, java.lang.String value) Set a String value with the given name, into the Map.

Methods inherited from interface javax.jms.Message

acknowledge, clearBody, 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

Method Detail

getBoolean

public boolean getBoolean(java.lang.String name)
                   throws JMSException

Return the boolean value with the given name.

Parameters:

name - the name of the boolean

Returns:

the boolean value with the given name.

Throws:

JMSException - if JMS fails to read message due to some internal JMS error.

MessageFormatException - if this type conversion is invalid.

getByte

public byte getByte(java.lang.String name)
             throws JMSException

Return the byte value with the given name.

Parameters:

name - the name of the byte

Returns:

the byte value with the given name.

Throws:

JMSException - if JMS fails to read message due to some internal JMS error.

MessageFormatException - if this type conversion is invalid.

getShort

public short getShort(java.lang.String name)
               throws JMSException

Return the short value with the given name.

Parameters:

name - the name of the short

Returns:

the short value with the given name.

Throws:

JMSException - if JMS fails to read message due to some internal JMS error.

MessageFormatException - if this type conversion is invalid.

getChar

public char getChar(java.lang.String name)
             throws JMSException

Return the Unicode character value with the given name.

Parameters:

name - the name of the Unicode character

Returns:

the Unicode character value with the given name.

Throws:

JMSException - if JMS fails to read message due to some internal JMS error.

MessageFormatException - if this type conversion is invalid.

getInt

public int getInt(java.lang.String name)
           throws JMSException

Return the integer value with the given name.

Parameters:

name - the name of the integer

Returns:

the integer value with the given name.

Throws:

JMSException - if JMS fails to read message due to some internal JMS error.

MessageFormatException - if this type conversion is invalid.

getLong

public long getLong(java.lang.String name)
             throws JMSException

Return the long value with the given name.

Parameters:

name - the name of the long

Returns:

the long value with the given name.

Throws:

JMSException - if JMS fails to read message due to some internal JMS error.

MessageFormatException - if this type conversion is invalid.

getFloat

public float getFloat(java.lang.String name)
               throws JMSException

Return the float value with the given name.

Parameters:

name - the name of the float

Returns:

the float value with the given name.

Throws:

JMSException - if JMS fails to read message due to some internal JMS error.

MessageFormatException - if this type conversion is invalid.

getDouble

public double getDouble(java.lang.String name)
                 throws JMSException

Return the double value with the given name.

Parameters:

name - the name of the double

Returns:

the double value with the given name.

Throws:

JMSException - if JMS fails to read message due to some internal JMS error.

MessageFormatException - if this type conversion is invalid.

getString

public java.lang.String getString(java.lang.String name)
                           throws JMSException

Return the String value with the given name.

Parameters:

name - the name of the String

Returns:

the String value with the given name. If there is no item by this name, a null value is returned.

Throws:

JMSException - if JMS fails to read message due to some internal JMS error.

MessageFormatException - if this type conversion is invalid.

getBytes

public byte[] getBytes(java.lang.String name)
                throws JMSException

Return the byte array value with the given name.

Parameters:

name - the name of the byte array

Returns:

a copy of the byte array value with the given name. If there is no item by this name, a null value is returned.

Throws:

JMSException - if JMS fails to read message due to some internal JMS error.

MessageFormatException - if this type conversion is invalid.

getObject

public java.lang.Object getObject(java.lang.String name)
                           throws JMSException

Return the Java object value with the given name.

Note that this method can be used to return in objectified format, an object that had been stored in the Map with the equivalent setObject method call, or it's equivalent primitive set method.

Parameters:

name - the name of the Java object

Returns:

a copy of the Java object value with the given name, in objectified format (ie. if it set as an int, then a Integer is returned). Note that byte values are returned as byte[], not Byte[]. If there is no item by this name, a null value is returned.

Throws:

JMSException - if JMS fails to read message due to some internal JMS error.

getMapNames

public java.util.Enumeration getMapNames()
                                  throws JMSException

Return an Enumeration of all the Map message's names.

Returns:

an enumeration of all the names in this Map message.

Throws:

JMSException - if JMS fails to read message due to some internal JMS error.

setBoolean

public void setBoolean(java.lang.String name,
                       boolean value)
                throws JMSException

Set a boolean value with the given name, into the Map.

Parameters:

name - the name of the boolean

value - the boolean value to set in the Map.

Throws:

JMSException - if JMS fails to write message due to some internal JMS error.

MessageNotWriteableException - if message in read-only mode.

setByte

public void setByte(java.lang.String name,
                    byte value)
             throws JMSException

Set a byte value with the given name, into the Map.

Parameters:

name - the name of the byte

value - the byte value to set in the Map.

Throws:

JMSException - if JMS fails to write message due to some internal JMS error.

MessageNotWriteableException - if message in read-only mode.

setShort

public void setShort(java.lang.String name,
                     short value)
              throws JMSException

Set a short value with the given name, into the Map.

Parameters:

name - the name of the short

value - the short value to set in the Map.

Throws:

JMSException - if JMS fails to write message due to some internal JMS error.

MessageNotWriteableException - if message in read-only mode.

setChar

public void setChar(java.lang.String name,
                    char value)
             throws JMSException

Set a Unicode character value with the given name, into the Map.

Parameters:

name - the name of the Unicode character

value - the Unicode character value to set in the Map.

Throws:

JMSException - if JMS fails to write message due to some internal JMS error.

MessageNotWriteableException - if message in read-only mode.

setInt

public void setInt(java.lang.String name,
                   int value)
            throws JMSException

Set an integer value with the given name, into the Map.

Parameters:

name - the name of the integer

value - the integer value to set in the Map.

Throws:

JMSException - if JMS fails to write message due to some internal JMS error.

MessageNotWriteableException - if message in read-only mode.

setLong

public void setLong(java.lang.String name,
                    long value)
             throws JMSException

Set a long value with the given name, into the Map.

Parameters:

name - the name of the long

value - the long value to set in the Map.

Throws:

JMSException - if JMS fails to write message due to some internal JMS error.

MessageNotWriteableException - if message in read-only mode.

setFloat

public void setFloat(java.lang.String name,
                     float value)
              throws JMSException

Set a float value with the given name, into the Map.

Parameters:

name - the name of the float

value - the float value to set in the Map.

Throws:

JMSException - if JMS fails to write message due to some internal JMS error.

MessageNotWriteableException - if message in read-only mode.

setDouble

public void setDouble(java.lang.String name,
                      double value)
               throws JMSException

Set a double value with the given name, into the Map.

Parameters:

name - the name of the double

value - the double value to set in the Map.

Throws:

JMSException - if JMS fails to write message due to some internal JMS error.

MessageNotWriteableException - if message in read-only mode.

setString

public void setString(java.lang.String name,
                      java.lang.String value)
               throws JMSException

Set a String value with the given name, into the Map.

Parameters:

name - the name of the String

value - the String value to set in the Map.

Throws:

JMSException - if JMS fails to write message due to some internal JMS error.

MessageNotWriteableException - if message in read-only mode.

setBytes

public void setBytes(java.lang.String name,
                     byte[] value)
              throws JMSException

Set a byte array value with the given name, into the Map.

Parameters:

name - the name of the byte array

value - the byte array value to set in the Map. The array is copied so the value for name will not be altered by future modifications.

Throws:

JMSException - if JMS fails to write message due to some internal JMS error.

MessageNotWriteableException - if message in read-only mode.

setBytes

public void setBytes(java.lang.String name,
                     byte[] value,
                     int offset,
                     int length)
              throws JMSException

Set a portion of the byte array value with the given name, into the Map.

Parameters:

name - the name of the byte array

value - the byte array value to set in the Map.

offset - the initial offset within the byte array.

length - the number of bytes to use.

Throws:

JMSException - if JMS fails to write message due to some internal JMS error.

MessageNotWriteableException - if message in read-only mode.

setObject

public void setObject(java.lang.String name,
                      java.lang.Object value)
               throws JMSException

Set a Java object value with the given name, into the Map.

Note that this method only works for the objectified primitive object types (Integer, Double, Long ...), String's and byte arrays.

Parameters:

name - the name of the Java object

value - the Java object value to set in the Map.

Throws:

JMSException - if JMS fails to write message due to some internal JMS error.

MessageFormatException - if object is invalid

MessageNotWriteableException - if message in read-only mode.

itemExists

public boolean itemExists(java.lang.String name)
                   throws JMSException

Check if an item exists in this MapMessage.

Parameters:

name - the name of the item to test

Returns:

true if the item does exist.

Throws:

JMSException - if a JMS error occurs.