AQjmsMapMessage - Oracle 9i

Syntax

All Implemented Interfaces
javax.jms.MapMessage, javax.jms.Message

Description
This class implements the MapMessage interface. A MapMessage is used to send a set of name-value pairs where names are Strings and values are java primitive types

AQjmsMapMessageAQjmsMapMessage

Inherited Member Summary

Fields inherited from interface javax.jms.Message DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY,

DEFAULT_TIME_TO_LIVE Methods inherited from class AQjmsMessageInherited Member Summary

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

MethodsclearBody()

public void clearBody()

Clear out the message body. All other parts of the message are left untouched. The message can now be both read and written to.

Specified By

javax.jms.Message.clearBody() in interface javax.jms.Message

Overrides
clearBody() in class AQjmsMessage

Throws
JMSException - if JMS fails to due to some internal JMS error.

clearProperties()

public void clearProperties()

Clear a message's properties.

Specified By

javax.jms.Message.clearProperties() in interface javax.jms.Message

Overrides

clearProperties() in class AQjmsMessage

Throws

JMSException - if JMS fails to clear JMS message properties due to some internal JMS errors

getBoolean(String)

public boolean getBoolean(java.lang.String name)

Return the boolean value with the given name.

Specified By

javax.jms.MapMessage.getBoolean(java.lang.String) in interface javax.jms.MapMessage

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(String)

public byte getByte(java.lang.String name)

Return the byte value with the given name.

Specified By

javax.jms.MapMessage.getByte(java.lang.String) in interface javax.jms.MapMessage

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.

getBytes(String)

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

Return the byte array value with the given name.

Specified By
javax.jms.MapMessage.getBytes(java.lang.String) in interface javax.jms.MapMessage

Parameters

name - the name of the byte array

Returns
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.

getChar(String)

public char getChar(java.lang.String name)

Return the Unicode character value with the given name.

Specified By

javax.jms.MapMessage.getChar(java.lang.String) in interface javax.jms.MapMessage

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.

getDouble(String)

public double getDouble(java.lang.String name)

Return the double value with the given name.

Specified By
javax.jms.MapMessage.getDouble(java.lang.String) in interface javax.jms.MapMessage

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.

getFloat(String)

public float getFloat(java.lang.String name)

Return the float value with the given name.

Specified By
javax.jms.MapMessage.getFloat(java.lang.String) in interface javax.jms.MapMessage

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.

getInt(String)

public int getInt(java.lang.String name)

Return the integer value with the given name.

Specified By

javax.jms.MapMessage.getInt(java.lang.String) in interface javax.jms.MapMessage

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(String)

public long getLong(java.lang.String name)

Return the long value with the given name.

Specified By

javax.jms.MapMessage.getLong(java.lang.String) in interface javax.jms.MapMessage

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.

getMapNames()

public java.util.Enumeration getMapNames()

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

Specified By

javax.jms.MapMessage.getMapNames() in interface javax.jms.MapMessage

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.

getObject(String)

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

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.

Specified By

javax.jms.MapMessage.getObject(java.lang.String) in interface javax.jms.MapMessage

Parameters

name - the name of the Java object

Returns
the Java object value with the given name, in objectified format

(i.e. if it set as an int, then a Integer is returned).

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.

getShort(String)

public short getShort(java.lang.String name)

Return the short value with the given name.

Specified By
javax.jms.MapMessage.getShort(java.lang.String) in interface javax.jms.MapMessage

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.

getString(String)

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

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

Specified By
javax.jms.MapMessage.getString(java.lang.String) in interface javax.jms.MapMessage

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

itemExists(String)

public boolean itemExists(java.lang.String name)

Check if an item exists in this MapMessage.

Specified By

javax.jms.MapMessage.itemExists(java.lang.String) in interface javax.jms.MapMessage

Parameters

name - the name of the item to test

Returns

true if the item does exist.

Throws

JMSException - if a JMS error occurs.

setBoolean(String, boolean)

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

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

Specified By

javax.jms.MapMessage.setBoolean(java.lang.String, boolean)

in interface javax.jms.MapMessage

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(String, byte)

public void setByte(java.lang.String name, byte value) Set a byte value with the given name, into the Map.

Specified By
javax.jms.MapMessage.setByte(java.lang.String, byte) in interface javax.jms.MapMessage

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.

setBytes(String, byte[])

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

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

Specified By

javax.jms.MapMessage.setBytes (java.lang.String, byte[]) in interface

javax.jms.MapMessage

Parameters

name - the name of the byte array value - the byte array 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(String, byte[], int, int)

public 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.

Specified By

javax.jms.MapMessage.setBytes(java.lang.String, byte[], int, int) in interface

javax.jms.MapMessage

Parameters

Throws

JMSException - if JMS fails to write message due to some internal JMS error. MessageNotWriteableException - if message in read-only mode.

setChar(String, char)

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

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

Specified By
javax.jms.MapMessage.setChar(java.lang.String, char) in interface javax.jms.MapMessage

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.

setDouble(String, double)

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

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

Specified By

javax.jms.MapMessage.setDouble (java.lang.String, double) in interface javax.jms.MapMessage

Parameters

name - the name of the double value - the double value to et 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(String, float)

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

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

Specified By
javax.jms.MapMessage.setFloat(java.lang.String, float) in interface javax.jms.MapMessage

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.

setInt(String, int)

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

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

Specified By

javax.jms.MapMessage.setInt(java.lang.String, int) in interface javax.jms.MapMessage

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(String, long)

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

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

Specified By
javax.jms.MapMessage.setLong(java.lang.String, long) in interface javax.jms.MapMessage

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.

setObject(String, Object)

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

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.

Specified By

javax.jms.MapMessage.setObject (java.lang.String, java.lang.Object) in interface javax.jms.MapMessage

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.

setShort(String, short)

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

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

Specified By

javax.jms.MapMessage.setShort(java.lang.String, short) in interface javax.jms.MapMessage

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.

setString(String, String)

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

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

Specified By

javax.jms.MapMessage.setString (java.lang.String, java.lang.String) in interface javax.jms.MapMessage

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.

All rights reserved © 2018 Wisdom IT Services India Pvt. Ltd DMCA.com Protection Status

Oracle 9i Topics