|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mqe.jms.MQeMessage | +--com.ibm.mqe.jms.MQeMapMessage
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 MQeMessage
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 MQeMessage.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 X |byte[] | X |----------------------------------------------------------------------
BytesMessage
,
Message
,
ObjectMessage
,
StreamMessage
,
TextMessage
Field Summary |
Fields inherited from class com.ibm.mqe.jms.MQeMessage |
DEFAULT_DELIVERY_MODE |
Fields inherited from interface javax.jms.Message |
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE |
Constructor Summary | |
MQeMapMessage()
|
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 obj)
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 class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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 |
Constructor Detail |
public MQeMapMessage()
Method Detail |
public boolean getBoolean(java.lang.String name) throws javax.jms.JMSException, javax.jms.MessageFormatException
getBoolean
in interface javax.jms.MapMessage
name
- the name of the boolean
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.
javax.jms.MessageFormatException
- if this type conversion is invalid.public byte getByte(java.lang.String name) throws javax.jms.JMSException, javax.jms.MessageFormatException
getByte
in interface javax.jms.MapMessage
name
- the name of the byte
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.
javax.jms.MessageFormatException
- if this type conversion is invalid.public short getShort(java.lang.String name) throws javax.jms.JMSException, javax.jms.MessageFormatException
getShort
in interface javax.jms.MapMessage
name
- the name of the short
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.
javax.jms.MessageFormatException
- if this type conversion is invalid.public char getChar(java.lang.String name) throws javax.jms.JMSException, javax.jms.MessageFormatException
getChar
in interface javax.jms.MapMessage
name
- the name of the Unicode character
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.
javax.jms.MessageFormatException
- if this type conversion is invalid.public int getInt(java.lang.String name) throws javax.jms.JMSException, javax.jms.MessageFormatException
getInt
in interface javax.jms.MapMessage
name
- the name of the integer
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.
javax.jms.MessageFormatException
- if this type conversion is invalid.public long getLong(java.lang.String name) throws javax.jms.JMSException, javax.jms.MessageFormatException
getLong
in interface javax.jms.MapMessage
name
- the name of the long
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.
javax.jms.MessageFormatException
- if this type conversion is invalid.public float getFloat(java.lang.String name) throws javax.jms.JMSException, javax.jms.MessageFormatException
getFloat
in interface javax.jms.MapMessage
name
- the name of the float
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.
javax.jms.MessageFormatException
- if this type conversion is invalid.public double getDouble(java.lang.String name) throws javax.jms.JMSException, javax.jms.MessageFormatException
getDouble
in interface javax.jms.MapMessage
name
- the name of the double
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.
javax.jms.MessageFormatException
- if this type conversion is invalid.public java.lang.String getString(java.lang.String name) throws javax.jms.JMSException
getString
in interface javax.jms.MapMessage
name
- the name of the String
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.
javax.jms.MessageFormatException
- if this type conversion is invalid.public byte[] getBytes(java.lang.String name) throws javax.jms.JMSException, javax.jms.MessageFormatException
getBytes
in interface javax.jms.MapMessage
name
- the name of the byte array
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.
javax.jms.MessageFormatException
- if this type conversion is invalid.public java.lang.Object getObject(java.lang.String name) throws javax.jms.JMSException
setObject(java.lang.String, java.lang.Object)
method call or it's equivalent primitive
set
getObject
in interface javax.jms.MapMessage
name
- the name of the Java object
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.public java.util.Enumeration getMapNames() throws javax.jms.JMSException
getMapNames
in interface javax.jms.MapMessage
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.public void setBoolean(java.lang.String name, boolean value) throws javax.jms.JMSException
setBoolean
in interface javax.jms.MapMessage
name
- the name of the booleanvalue
- the boolean value to set in the Map.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.
javax.jms.MessageNotWriteableException
- if message in read-only mode.public void setByte(java.lang.String name, byte value) throws javax.jms.JMSException
setByte
in interface javax.jms.MapMessage
name
- the name of the bytevalue
- the byte value to set in the Map.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.
javax.jms.MessageNotWriteableException
- if message in read-only mode.public void setShort(java.lang.String name, short value) throws javax.jms.JMSException
setShort
in interface javax.jms.MapMessage
name
- the name of the shortvalue
- the short value to set in the Map.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.
javax.jms.MessageNotWriteableException
- if message in read-only mode.public void setChar(java.lang.String name, char value) throws javax.jms.JMSException
setChar
in interface javax.jms.MapMessage
name
- the name of the Unicode charactervalue
- the Unicode character value to set in the Map.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.
javax.jms.MessageNotWriteableException
- if message in read-only mode.public void setInt(java.lang.String name, int value) throws javax.jms.JMSException
setInt
in interface javax.jms.MapMessage
name
- the name of the integervalue
- the integer value to set in the Map.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.
javax.jms.MessageNotWriteableException
- if message in read-only mode.public void setLong(java.lang.String name, long value) throws javax.jms.JMSException
setLong
in interface javax.jms.MapMessage
name
- the name of the longvalue
- the long value to set in the Map.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.
javax.jms.MessageNotWriteableException
- if message in read-only mode.public void setFloat(java.lang.String name, float value) throws javax.jms.JMSException
setFloat
in interface javax.jms.MapMessage
name
- the name of the floatvalue
- the float value to set in the Map.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.
javax.jms.MessageNotWriteableException
- if message in read-only mode.public void setDouble(java.lang.String name, double value) throws javax.jms.JMSException
setDouble
in interface javax.jms.MapMessage
name
- the name of the doublevalue
- the double value to set in the Map.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.
javax.jms.MessageNotWriteableException
- if message in read-only mode.public void setString(java.lang.String name, java.lang.String value) throws javax.jms.JMSException
setString
in interface javax.jms.MapMessage
name
- the name of the Stringvalue
- the String value to set in the Map.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.
javax.jms.MessageNotWriteableException
- if message in read-only mode.public void setBytes(java.lang.String name, byte[] value) throws javax.jms.JMSException
setBytes
in interface javax.jms.MapMessage
name
- the name of the byte arrayvalue
- the byte array value to set in the Map.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.
javax.jms.MessageNotWriteableException
- if message in read-only mode.public void setBytes(java.lang.String name, byte[] value, int offset, int length) throws javax.jms.JMSException
setBytes
in interface javax.jms.MapMessage
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.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.
javax.jms.MessageNotWriteableException
- if message in read-only mode.public void setObject(java.lang.String name, java.lang.Object obj) throws javax.jms.JMSException
setObject
in interface javax.jms.MapMessage
name
- the name of the Java object
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.
javax.jms.MessageFormatException
- if object is invalid
javax.jms.MessageNotWriteableException
- if message in read-only mode.public boolean itemExists(java.lang.String name) throws javax.jms.JMSException
itemExists
in interface javax.jms.MapMessage
name
- the name of the item to test
javax.jms.JMSException
- if a JMS error occurs.
|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |