|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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(String name)
Return the boolean value with the given name. |
byte |
getByte(String name)
Return the byte value with the given name. |
byte[] |
getBytes(String name)
Return the byte array value with the given name. |
char |
getChar(String name)
Return the Unicode character value with the given name. |
double |
getDouble(String name)
Return the double value with the given name. |
float |
getFloat(String name)
Return the float value with the given name. |
int |
getInt(String name)
Return the integer value with the given name. |
long |
getLong(String name)
Return the long value with the given name. |
Enumeration |
getMapNames()
Return an Enumeration of all the Map message's names. |
Object |
getObject(String name)
Return the Java object value with the given name. |
short |
getShort(String name)
Return the short value with the given name. |
String |
getString(String name)
Return the String value with the given name. |
boolean |
itemExists(String name)
Check if an item exists in this MapMessage. |
void |
setBoolean(String name,
boolean value)
Set a boolean value with the given name, into the Map. |
void |
setByte(String name,
byte value)
Set a byte value with the given name, into the Map. |
void |
setBytes(String name,
byte[] value)
Set a byte array value with the given name, into the Map. |
void |
setBytes(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(String name,
char value)
Set a Unicode character value with the given name, into the Map. |
void |
setDouble(String name,
double value)
Set a double value with the given name, into the Map. |
void |
setFloat(String name,
float value)
Set a float value with the given name, into the Map. |
void |
setInt(String name,
int value)
Set an integer value with the given name, into the Map. |
void |
setLong(String name,
long value)
Set a long value with the given name, into the Map. |
void |
setObject(String name,
Object value)
Set a Java object value with the given name, into the Map. |
void |
setShort(String name,
short value)
Set a short value with the given name, into the Map. |
void |
setString(String name,
String value)
Set a String value with the given name, into the Map. |
Method Detail |
public boolean getBoolean(String name) throws JMSException
name
- the name of the booleanJMSException
- if JMS fails to read message due to
some internal JMS error.MessageFormatException
- if this type conversion is invalid.public byte getByte(String name) throws JMSException
name
- the name of the byteJMSException
- if JMS fails to read message due to
some internal JMS error.MessageFormatException
- if this type conversion is invalid.public short getShort(String name) throws JMSException
name
- the name of the shortJMSException
- if JMS fails to read message due to
some internal JMS error.MessageFormatException
- if this type conversion is invalid.public char getChar(String name) throws JMSException
name
- the name of the Unicode characterJMSException
- if JMS fails to read message due to
some internal JMS error.MessageFormatException
- if this type conversion is invalid.public int getInt(String name) throws JMSException
name
- the name of the integerJMSException
- if JMS fails to read message due to
some internal JMS error.MessageFormatException
- if this type conversion is invalid.public long getLong(String name) throws JMSException
name
- the name of the longJMSException
- if JMS fails to read message due to
some internal JMS error.MessageFormatException
- if this type conversion is invalid.public float getFloat(String name) throws JMSException
name
- the name of the floatJMSException
- if JMS fails to read message due to
some internal JMS error.MessageFormatException
- if this type conversion is invalid.public double getDouble(String name) throws JMSException
name
- the name of the doubleJMSException
- if JMS fails to read message due to
some internal JMS error.MessageFormatException
- if this type conversion is invalid.public String getString(String name) throws JMSException
name
- the name of the StringJMSException
- if JMS fails to read message due to
some internal JMS error.MessageFormatException
- if this type conversion is invalid.public byte[] getBytes(String name) throws JMSException
name
- the name of the byte arrayJMSException
- if JMS fails to read message due to
some internal JMS error.MessageFormatException
- if this type conversion is invalid.public Object getObject(String name) throws JMSException
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
name
- the name of the Java objectJMSException
- if JMS fails to read message due to
some internal JMS error.
public Enumeration getMapNames() throws JMSException
JMSException
- if JMS fails to read message due to
some internal JMS error.public void setBoolean(String name, boolean value) throws JMSException
name
- the name of the booleanvalue
- the boolean value to set in the Map.JMSException
- if JMS fails to write message due to
some internal JMS error.MessageNotWriteableException
- if message in read-only mode.public void setByte(String name, byte value) throws JMSException
name
- the name of the bytevalue
- the byte value to set in the Map.JMSException
- if JMS fails to write message due to
some internal JMS error.MessageNotWriteableException
- if message in read-only mode.public void setShort(String name, short value) throws JMSException
name
- the name of the shortvalue
- the short value to set in the Map.JMSException
- if JMS fails to write message due to
some internal JMS error.MessageNotWriteableException
- if message in read-only mode.public void setChar(String name, char value) throws JMSException
name
- the name of the Unicode charactervalue
- the Unicode character value to set in the Map.JMSException
- if JMS fails to write message due to
some internal JMS error.MessageNotWriteableException
- if message in read-only mode.public void setInt(String name, int value) throws JMSException
name
- the name of the integervalue
- the integer value to set in the Map.JMSException
- if JMS fails to write message due to
some internal JMS error.MessageNotWriteableException
- if message in read-only mode.public void setLong(String name, long value) throws JMSException
name
- the name of the longvalue
- the long value to set in the Map.JMSException
- if JMS fails to write message due to
some internal JMS error.MessageNotWriteableException
- if message in read-only mode.public void setFloat(String name, float value) throws JMSException
name
- the name of the floatvalue
- the float value to set in the Map.JMSException
- if JMS fails to write message due to
some internal JMS error.MessageNotWriteableException
- if message in read-only mode.public void setDouble(String name, double value) throws JMSException
name
- the name of the doublevalue
- the double value to set in the Map.JMSException
- if JMS fails to write message due to
some internal JMS error.MessageNotWriteableException
- if message in read-only mode.public void setString(String name, String value) throws JMSException
name
- the name of the Stringvalue
- the String value to set in the Map.JMSException
- if JMS fails to write message due to
some internal JMS error.MessageNotWriteableException
- if message in read-only mode.public void setBytes(String name, byte[] value) throws JMSException
name
- the name of the byte arrayvalue
- 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.JMSException
- if JMS fails to write message due to
some internal JMS error.MessageNotWriteableException
- if message in read-only mode.public void setBytes(String name, byte[] value, int offset, int length) throws JMSException
name
- the name of the byte arrayvalue
- the byte array value to set in the Map.offset
- the initial offset within the byte array.length
- the number of bytes to use.JMSException
- if JMS fails to write message due to
some internal JMS error.MessageNotWriteableException
- if message in read-only mode.public void setObject(String name, Object value) throws JMSException
Note that this method only works for the objectified primitive object types (Integer, Double, Long ...), String's and byte arrays.
name
- the name of the Java objectvalue
- the Java object value to set in the Map.JMSException
- if JMS fails to write message due to
some internal JMS error.MessageFormatException
- if object is invalidMessageNotWriteableException
- if message in read-only mode.public boolean itemExists(String name) throws JMSException
name
- the name of the item to testJMSException
- if a JMS error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |