Movatterモバイル変換

Interface MapMessage

All Superinterfaces:

Message

public interfaceMapMessage

extendsMessage

AMapMessage object is used to send a set of name-value pairs. The names areString objects, and the values are primitive data types in the Java programming language. The entries can be accessed sequentially or randomly by name. The order of the entries is undefined.MapMessage inherits from theMessage interface and adds a message body that contains a Map.

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 toMapMessage.setInt("foo", 6) is equivalent toMapMessage.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 aMapMessage, it is in read-only mode. If a client attempts to write to the message at this point, aMessageNotWriteableException is thrown. IfclearBody is called, the message can now be both read from and written to.

MapMessage objects support the following conversion table. The marked cases must be supported. The unmarked cases must throw aJMSException. TheString-to-primitive conversions may throw a runtime exception if the primitive'svalueOf() method does not accept it as a validString 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 primitive type must be treated as calling the primitive's correspondingvalueOf(String) conversion method with a null value. Sincechar does not support aString conversion, attempting to read a null value as achar must throw aNullPointerException.

See Also:

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

getBoolean

public booleangetBoolean(java.lang.String name)                   throwsJMSException

Returns theboolean value with the specified name.

Parameters:

name - the name of theboolean

Returns:

theboolean value with the specified name

Throws:

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

MessageFormatException - if this type conversion is invalid.

getByte

public bytegetByte(java.lang.String name)             throwsJMSException

Returns thebyte value with the specified name.

Parameters:

name - the name of thebyte

Returns:

thebyte value with the specified name

Throws:

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

MessageFormatException - if this type conversion is invalid.

getShort

public shortgetShort(java.lang.String name)               throwsJMSException

Returns theshort value with the specified name.

Parameters:

name - the name of theshort

Returns:

theshort value with the specified name

Throws:

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

MessageFormatException - if this type conversion is invalid.

getChar

public chargetChar(java.lang.String name)             throwsJMSException

Returns the Unicode character value with the specified name.

Parameters:

name - the name of the Unicode character

Returns:

the Unicode character value with the specified name

Throws:

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

MessageFormatException - if this type conversion is invalid.

getInt

public intgetInt(java.lang.String name)           throwsJMSException

Returns theint value with the specified name.

Parameters:

name - the name of theint

Returns:

theint value with the specified name

Throws:

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

MessageFormatException - if this type conversion is invalid.

getLong

public longgetLong(java.lang.String name)             throwsJMSException

Returns thelong value with the specified name.

Parameters:

name - the name of thelong

Returns:

thelong value with the specified name

Throws:

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

MessageFormatException - if this type conversion is invalid.

getFloat

public floatgetFloat(java.lang.String name)               throwsJMSException

Returns thefloat value with the specified name.

Parameters:

name - the name of thefloat

Returns:

thefloat value with the specified name

Throws:

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

MessageFormatException - if this type conversion is invalid.

getDouble

public doublegetDouble(java.lang.String name)                 throwsJMSException

Returns thedouble value with the specified name.

Parameters:

name - the name of thedouble

Returns:

thedouble value with the specified name

Throws:

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

MessageFormatException - if this type conversion is invalid.

getString

public java.lang.StringgetString(java.lang.String name)                           throwsJMSException

Returns theString value with the specified name.

Parameters:

name - the name of theString

Returns:

theString value with the specified name; if there is no item by this name, a null value is returned

Throws:

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

MessageFormatException - if this type conversion is invalid.

getBytes

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

Returns the byte array value with the specified name.

Parameters:

name - the name of the byte array

Returns:

a copy of the byte array value with the specified name; if there is no item by this name, a null value is returned.

Throws:

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

MessageFormatException - if this type conversion is invalid.

getObject

public java.lang.ObjectgetObject(java.lang.String name)                           throwsJMSException

Returns the value of the object with the specified name.

This method can be used to return, in objectified format, an object in the Java programming language ("Java object") that had been stored in the Map with the equivalentsetObject method call, or its equivalent primitivesettype method.

Note that byte values are returned asbyte[], notByte[].

Parameters:

name - the name of the Java object

Returns:

a copy of the Java object value with the specified name, in objectified format (for example, if the object was set as anint, anInteger is returned); if there is no item by this name, a null value is returned

Throws:

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

getMapNames

public java.util.EnumerationgetMapNames()                                  throwsJMSException

Returns anEnumeration of all the names in theMapMessage object.

Returns:

an enumeration of all the names in thisMapMessage

Throws:

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

setBoolean

public voidsetBoolean(java.lang.String name,                       boolean value)                throwsJMSException

Sets aboolean value with the specified name into the Map.

Parameters:

name - the name of theboolean

value - theboolean value to set in the Map

Throws:

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

MessageNotWriteableException - if the message is in read-only mode.

setByte

public voidsetByte(java.lang.String name,                    byte value)             throwsJMSException

Sets abyte value with the specified name into the Map.

Parameters:

name - the name of thebyte

value - thebyte value to set in the Map

Throws:

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

MessageNotWriteableException - if the message is in read-only mode.

setShort

public voidsetShort(java.lang.String name,                     short value)              throwsJMSException

Sets ashort value with the specified name into the Map.

Parameters:

name - the name of theshort

value - theshort value to set in the Map

Throws:

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

MessageNotWriteableException - if the message is in read-only mode.

setChar

public voidsetChar(java.lang.String name,                    char value)             throwsJMSException

Sets a Unicode character value with the specified 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 the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - if the message is in read-only mode.

setInt

public voidsetInt(java.lang.String name,                   int value)            throwsJMSException

Sets anint value with the specified name into the Map.

Parameters:

name - the name of theint

value - theint value to set in the Map

Throws:

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

MessageNotWriteableException - if the message is in read-only mode.

setLong

public voidsetLong(java.lang.String name,                    long value)             throwsJMSException

Sets along value with the specified name into the Map.

Parameters:

name - the name of thelong

value - thelong value to set in the Map

Throws:

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

MessageNotWriteableException - if the message is in read-only mode.

setFloat

public voidsetFloat(java.lang.String name,                     float value)              throwsJMSException

Sets afloat value with the specified name into the Map.

Parameters:

name - the name of thefloat

value - thefloat value to set in the Map

Throws:

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

MessageNotWriteableException - if the message is in read-only mode.

setDouble

public voidsetDouble(java.lang.String name,                      double value)               throwsJMSException

Sets adouble value with the specified name into the Map.

Parameters:

name - the name of thedouble

value - thedouble value to set in the Map

Throws:

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

MessageNotWriteableException - if the message is in read-only mode.

setString

public voidsetString(java.lang.String name,                      java.lang.String value)               throwsJMSException

Sets aString value with the specified name into the Map.

Parameters:

name - the name of theString

value - theString value to set in the Map

Throws:

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

MessageNotWriteableException - if the message is in read-only mode.

setBytes

public voidsetBytes(java.lang.String name,                     byte[] value)              throwsJMSException

Sets a byte array value with the specified 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 that the value forname will not be altered by future modifications

Throws:

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

MessageNotWriteableException - if the message is in read-only mode.

setBytes

public voidsetBytes(java.lang.String name,                     byte[] value,                     int offset,                     int length)              throwsJMSException

Sets a portion of the byte array value with the specified 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 the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - if the message is in read-only mode.

setObject

public voidsetObject(java.lang.String name,                      java.lang.Object value)               throwsJMSException

Sets an object value with the specified name into the Map.

This method works only for the objectified primitive object types (Integer,Double,Long ...),String objects, and byte arrays.

Parameters:

name - the name of the Java object

value - the Java object value to set in the Map

Throws:

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

MessageFormatException - if the object is invalid.

MessageNotWriteableException - if the message is in read-only mode.

itemExists

public booleanitemExists(java.lang.String name)                   throwsJMSException

Indicates whether an item exists in thisMapMessage object.

Parameters:

name - the name of the item to test

Returns:

true if the item exists

Throws:

JMSException - if the JMS provider fails to determine if the item exists due to some internal error.