public class AQjmsMapMessage extends AQjmsMessage implements MapMessage
javax.jms.MapMessage
.DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
Modifier and Type | Method and Description |
---|---|
void |
clearBody()
Clear out the message body.
|
boolean |
getBoolean(java.lang.String name)
Returns the
boolean value with the specified name. |
byte |
getByte(java.lang.String name)
Returns the
byte value with the specified name. |
byte[] |
getBytes(java.lang.String name)
Returns the byte array value with the specified name.
|
char |
getChar(java.lang.String name)
Returns the Unicode character value with the specified name.
|
double |
getDouble(java.lang.String name)
Returns the
double value with the specified name. |
float |
getFloat(java.lang.String name)
Returns the
float value with the specified name. |
int |
getInt(java.lang.String name)
Returns the
int value with the specified name. |
long |
getLong(java.lang.String name)
Returns the
long value with the specified name. |
java.util.Enumeration |
getMapNames()
Returns an
Enumeration of all the names in the MapMessage object. |
java.lang.Object |
getObject(java.lang.String name)
Returns the value of the object with the specified name.
|
short |
getShort(java.lang.String name)
Returns the
short value with the specified name. |
java.lang.String |
getString(java.lang.String name)
Returns the
String value with the specified name. |
boolean |
itemExists(java.lang.String name)
Indicates whether an item exists in this
MapMessage object. |
void |
setBoolean(java.lang.String name, boolean value)
Sets a
boolean value with the specified name into the Map. |
void |
setByte(java.lang.String name, byte value)
Sets a
byte value with the specified name into the Map. |
void |
setBytes(java.lang.String name, byte[] value)
Sets a byte array value with the specified name into the Map.
|
void |
setBytes(java.lang.String name, byte[] value, int offset, int length)
Sets a portion of the byte array value with the specified name into the Map.
|
void |
setChar(java.lang.String name, char value)
Sets a Unicode character value with the specified name into the Map.
|
void |
setDouble(java.lang.String name, double value)
Sets a
double value with the specified name into the Map. |
void |
setFloat(java.lang.String name, float value)
Sets a
float value with the specified name into the Map. |
void |
setInt(java.lang.String name, int value)
Sets an
int value with the specified name into the Map. |
void |
setLong(java.lang.String name, long value)
Sets a
long value with the specified name into the Map. |
void |
setObject(java.lang.String name, java.lang.Object value)
Sets an object value with the specified name into the Map.
|
void |
setShort(java.lang.String name, short value)
Sets a
short value with the specified name into the Map. |
void |
setString(java.lang.String name, java.lang.String value)
Sets a
String value with the specified name into the Map. |
acknowledge, clearProperties, getAttempts, getBodyLength, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSMessageIDAsBytes, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getSenderID, getShortProperty, getStringProperty, getUserPropertyNames, isLargeBody, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setSenderID, setShortProperty, setStringProperty, test_getUserProperties
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
acknowledge, 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
public void setBoolean(java.lang.String name, boolean value) throws JMSException
boolean
value with the specified name into the Map.setBoolean
in interface MapMessage
name
- the name of the boolean
value
- the boolean
value to set in the MapJMSException
- if the JMS provider fails to write the message due to some internal error.java.lang.IllegalArgumentException
- if the name is null or if the name is an empty string.MessageNotWriteableException
- if the message is in read-only mode.public void setByte(java.lang.String name, byte value) throws JMSException
byte
value with the specified name into the Map.setByte
in interface MapMessage
name
- the name of the byte
value
- the byte
value to set in the MapJMSException
- if the JMS provider fails to write the message due to some internal error.java.lang.IllegalArgumentException
- if the name is null or if the name is an empty string.MessageNotWriteableException
- if the message is in read-only mode.public void setShort(java.lang.String name, short value) throws JMSException
short
value with the specified name into the Map.setShort
in interface MapMessage
name
- the name of the short
value
- the short
value to set in the MapJMSException
- if the JMS provider fails to write the message due to some internal error.java.lang.IllegalArgumentException
- if the name is null or if the name is an empty string.MessageNotWriteableException
- if the message is in read-only mode.public void setChar(java.lang.String name, char value) throws JMSException
setChar
in interface MapMessage
name
- the name of the Unicode charactervalue
- the Unicode character value to set in the MapJMSException
- if the JMS provider fails to write the message due to some internal error.java.lang.IllegalArgumentException
- if the name is null or if the name is an empty string.MessageNotWriteableException
- if the message is in read-only mode.public void setDouble(java.lang.String name, double value) throws JMSException
double
value with the specified name into the Map.setDouble
in interface MapMessage
name
- the name of the double
value
- the double
value to set in the MapJMSException
- if the JMS provider fails to write the message due to some internal error.java.lang.IllegalArgumentException
- if the name is null or if the name is an empty string.MessageNotWriteableException
- if the message is in read-only mode.public void setFloat(java.lang.String name, float value) throws JMSException
float
value with the specified name into the Map.setFloat
in interface MapMessage
name
- the name of the float
value
- the float
value to set in the MapJMSException
- if the JMS provider fails to write the message due to some internal error.java.lang.IllegalArgumentException
- if the name is null or if the name is an empty string.MessageNotWriteableException
- if the message is in read-only mode.public void setInt(java.lang.String name, int value) throws JMSException
int
value with the specified name into the Map.setInt
in interface MapMessage
name
- the name of the int
value
- the int
value to set in the MapJMSException
- if the JMS provider fails to write the message due to some internal error.java.lang.IllegalArgumentException
- if the name is null or if the name is an empty string.MessageNotWriteableException
- if the message is in read-only mode.public void setLong(java.lang.String name, long value) throws JMSException
long
value with the specified name into the Map.setLong
in interface MapMessage
name
- the name of the long
value
- the long
value to set in the MapJMSException
- if the JMS provider fails to write the message due to some internal error.java.lang.IllegalArgumentException
- if the name is null or if the name is an empty string.MessageNotWriteableException
- if the message is in read-only mode.public void setString(java.lang.String name, java.lang.String value) throws JMSException
String
value with the specified name into the Map.setString
in interface MapMessage
name
- the name of the String
value
- the String
value to set in the MapJMSException
- if the JMS provider fails to write the message due to some internal error.java.lang.IllegalArgumentException
- if the name is null or if the name is an empty string.MessageNotWriteableException
- if the message is in read-only mode.public void setObject(java.lang.String name, java.lang.Object value) throws JMSException
This method works only for the objectified primitive object types (Integer
, Double
, Long
...), String
objects, and byte arrays.
setObject
in interface MapMessage
name
- the name of the Java objectvalue
- the Java object value to set in the MapJMSException
- if the JMS provider fails to write the message due to some internal error.java.lang.IllegalArgumentException
- if the name is null or if the name is an empty string.MessageFormatException
- if the object is invalid.MessageNotWriteableException
- if the message is in read-only mode.public void setBytes(java.lang.String name, byte[] value) throws JMSException
setBytes
in interface MapMessage
name
- the name of the byte arrayvalue
- the byte array value to set in the Map; the array is copied so that the value for name
will not be altered by future modificationsJMSException
- if the JMS provider fails to write the message due to some internal error.java.lang.NullPointerException
- if the name is null, or if the name is an empty string.MessageNotWriteableException
- if the message is in read-only mode.public void setBytes(java.lang.String name, byte[] value, int offset, int length) throws JMSException
setBytes
in interface MapMessage
name
- the name of the byte arrayvalue
- the byte array value to set in the Mapoffset
- the initial offset within the byte arraylength
- the number of bytes to useJMSException
- if the JMS provider fails to write the message due to some internal error.java.lang.IllegalArgumentException
- if the name is null or if the name is an empty string.MessageNotWriteableException
- if the message is in read-only mode.public boolean getBoolean(java.lang.String name) throws JMSException
boolean
value with the specified name.getBoolean
in interface MapMessage
name
- the name of the boolean
boolean
value with the specified nameJMSException
- if the JMS provider fails to read the message due to some internal error.MessageFormatException
- if this type conversion is invalid.public byte getByte(java.lang.String name) throws JMSException
byte
value with the specified name.getByte
in interface MapMessage
name
- the name of the byte
byte
value with the specified nameJMSException
- if the JMS provider fails to read the message due to some internal error.MessageFormatException
- if this type conversion is invalid.public byte[] getBytes(java.lang.String name) throws JMSException
getBytes
in interface MapMessage
name
- the name of the byte arrayJMSException
- if the JMS provider fails to read the message due to some internal error.MessageFormatException
- if this type conversion is invalid.public char getChar(java.lang.String name) throws JMSException
getChar
in interface MapMessage
name
- the name of the Unicode characterJMSException
- if the JMS provider fails to read the message due to some internal error.MessageFormatException
- if this type conversion is invalid.public double getDouble(java.lang.String name) throws JMSException
double
value with the specified name.getDouble
in interface MapMessage
name
- the name of the double
double
value with the specified nameJMSException
- if the JMS provider fails to read the message due to some internal error.MessageFormatException
- if this type conversion is invalid.public float getFloat(java.lang.String name) throws JMSException
float
value with the specified name.getFloat
in interface MapMessage
name
- the name of the float
float
value with the specified nameJMSException
- if the JMS provider fails to read the message due to some internal error.MessageFormatException
- if this type conversion is invalid.public int getInt(java.lang.String name) throws JMSException
int
value with the specified name.getInt
in interface MapMessage
name
- the name of the int
int
value with the specified nameJMSException
- if the JMS provider fails to read the message due to some internal error.MessageFormatException
- if this type conversion is invalid.public long getLong(java.lang.String name) throws JMSException
long
value with the specified name.getLong
in interface MapMessage
name
- the name of the long
long
value with the specified nameJMSException
- if the JMS provider fails to read the message due to some internal error.MessageFormatException
- if this type conversion is invalid.public java.util.Enumeration getMapNames() throws JMSException
Enumeration
of all the names in the MapMessage
object.getMapNames
in interface MapMessage
MapMessage
JMSException
- if the JMS provider fails to read the message due to some internal error.public java.lang.Object getObject(java.lang.String name) throws JMSException
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 equivalent setObject
method call, or its equivalent primitive settype
method.
Note that byte values are returned as byte[]
, not Byte[]
.
getObject
in interface MapMessage
name
- the name of the Java objectint
, an Integer
is returned); if there is no item by this name, a null value is returnedJMSException
- if the JMS provider fails to read the message due to some internal error.public short getShort(java.lang.String name) throws JMSException
short
value with the specified name.getShort
in interface MapMessage
name
- the name of the short
short
value with the specified nameJMSException
- if the JMS provider fails to read the message due to some internal error.MessageFormatException
- if this type conversion is invalid.public java.lang.String getString(java.lang.String name) throws JMSException
String
value with the specified name.getString
in interface MapMessage
name
- the name of the String
String
value with the specified name; if there is no item by this name, a null value is returnedJMSException
- if the JMS provider fails to read the message due to some internal error.MessageFormatException
- if this type conversion is invalid.public boolean itemExists(java.lang.String name) throws JMSException
MapMessage
object.itemExists
in interface MapMessage
name
- the name of the item to testJMSException
- if the JMS provider fails to determine if the item exists due to some internal error.public void clearBody() throws JMSException
clearBody
in interface Message
clearBody
in class AQjmsMessage
JMSException
- if JMS fails to due to some internal JMS error.