All Packages Class Hierarchy This Package Previous Next Index
Interface bea.jolt.Message
- public interface Message
This interface provides the set, get, add, and delete methods to
interact with any instance of an item in the message object.
-
addByte(String, byte)
- Add a byte item referred by its name.
-
addBytes(String, byte[], int)
- Add a byte-array item referred by its name.
-
addDouble(String, double)
- Add a double item referred by its name.
-
addFloat(String, float)
- Add a float item referred by its name.
-
addInt(String, int)
- Add a int item referred by its name.
-
addShort(String, short)
- Add a short item referred by its name.
-
addString(String, String)
- Add a string item referred by its name.
-
clear()
- Remove all items from the message.
-
delete(String)
- Delete the first item with the matching name.
-
deleteItem(String, int)
- Delete an occurrence of an item referred by its name.
-
getByteDef(String, byte)
- Get the 1st item based on its name.
-
getByteItemDef(String, int, byte)
- Get an occurrence of a named item of byte data type.
-
getBytesDef(String, byte[])
- Get the 1st item based on its name.
-
getBytesItemDef(String, int, byte[])
- Get an occurrence of a named item of byte-array data type.
-
getDoubleDef(String, double)
- Get the 1st item based on its name.
-
getDoubleItemDef(String, int, double)
- Get an occurrence of a named item of double data type.
-
getFloatDef(String, float)
- Get the 1st item based on its name.
-
getFloatItemDef(String, int, float)
- Get an occurrence of a named item of float data type.
-
getIntDef(String, int)
- Get the 1st item based on its name.
-
getIntItemDef(String, int, int)
- Get an occurrence of a named item of int data type.
-
getOccurrenceCount(String)
- Get the number of occurrence of a named item.
-
getShortDef(String, short)
- Get the 1st item based on its name.
-
getShortItemDef(String, int, short)
- Get an occurrence of a named item of short data type.
-
getStringDef(String, String)
- Get the 1st item based on its name.
-
getStringItemDef(String, int, String)
- Get an occurrence of a named item of string data type.
-
setByte(String, byte)
- Change the value for the first instance of the named item
of byte data type.
-
setByteItem(String, int, byte)
- Change the byte value of an occurrence of the named item.
-
setBytes(String, byte[], int)
- Change the value for the first instance of the named item of
byte-array data type.
-
setBytesItem(String, int, byte[], int)
- Change the byte-array value of an occurrence of the named item.
-
setDouble(String, double)
- Change the value for the first instance of the named item
of a double data type.
-
setDoubleItem(String, int, double)
- Change the double value of an occurrence of the named item.
-
setFloat(String, float)
- Change the value for the first instance of the named item
of a float data type.
-
setFloatItem(String, int, float)
- Change the float value of an occurrence of the named item.
-
setInt(String, int)
- Change the value for the first instance of the named item
of an int data type.
-
setIntItem(String, int, int)
- Change the int value of an occurrence of the named item.
-
setShort(String, short)
- Change the value for the first instance of the named item
of a short data type.
-
setShortItem(String, int, short)
- Change the short value of an occurrence of the named item.
-
setString(String, String)
- Change the value for the first instance of the named item of a
string data type.
-
setStringItem(String, int, String)
- Change the string value of an occurrence of the named item.
clear
public abstract void clear()
- Remove all items from the message.
setByte
public abstract void setByte(String name,
byte val)
- Change the value for the first instance of the named item
of byte data type. If the item does not exist, it will be added.
- Parameters:
- name - The name of the item to be set or changed.
- val - The byte value to be set or changed to.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
setShort
public abstract void setShort(String name,
short val)
- Change the value for the first instance of the named item
of a short data type. If the item does not exist, it will be added.
- Parameters:
- name - The name of the item to be set or changed.
- val - The short value to be set or changed to.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
setInt
public abstract void setInt(String name,
int val)
- Change the value for the first instance of the named item
of an int data type. If the item does not exist, it will be added.
- Parameters:
- name - The name of the item to be set or changed.
- val - The int value to be set or changed to.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
setFloat
public abstract void setFloat(String name,
float val)
- Change the value for the first instance of the named item
of a float data type. If the item does not exist, it will be added.
- Parameters:
- name - The name of the item to be set or changed.
- val - The float value to be set or changed to.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
setDouble
public abstract void setDouble(String name,
double val)
- Change the value for the first instance of the named item
of a double data type. If the item does not exist, it will be added.
- Parameters:
- name - The name of the item to be set or changed.
- val - The double value to be set or changed to.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
setString
public abstract void setString(String name,
String val)
- Change the value for the first instance of the named item of a
string data type. If the item does not exist, it will be added.
- Parameters:
- name - The name of the item to be set or changed.
- val - The string value to be set or changed to.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
setBytes
public abstract void setBytes(String name,
byte val[],
int len)
- Change the value for the first instance of the named item of
byte-array data type. If the item does not exist, it will be added.
- Parameters:
- name - The name of the item to be set or changed.
- val - The byte-array value to be set or changed to.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
getByteDef
public abstract byte getByteDef(String name,
byte def)
- Get the 1st item based on its name. If it does not exist, the
default value will be returned.
- Parameters:
- name - The name of the item.
- def - The default byte value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is not an output item.
getShortDef
public abstract short getShortDef(String name,
short def)
- Get the 1st item based on its name. If it does not exist, the
default value will be returned.
- Parameters:
- name - The name of the item.
- def - The default short value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is not an output item.
getIntDef
public abstract int getIntDef(String name,
int def)
- Get the 1st item based on its name. If it does not exist, the
default value will be returned.
- Parameters:
- name - The name of the item.
- def - The default int value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is not an output item.
getFloatDef
public abstract float getFloatDef(String name,
float def)
- Get the 1st item based on its name. If it does not exist, the
default value will be returned.
- Parameters:
- name - The name of the item.
- def - The default float value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is not an output item.
getDoubleDef
public abstract double getDoubleDef(String name,
double def)
- Get the 1st item based on its name. If it does not exist, the
default value will be returned.
- Parameters:
- name - The name of the item.
- def - The default double value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is not an output item.
getStringDef
public abstract String getStringDef(String name,
String def)
- Get the 1st item based on its name. If it does not exist, the
default value will be returned.
- Parameters:
- name - The name of the item.
- def - The default string value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is not an output item.
getBytesDef
public abstract byte[] getBytesDef(String name,
byte def[])
- Get the 1st item based on its name. If it does not exist, the
default value will be returned.
- Parameters:
- name - The name of the item.
- def - The default byte-array value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is not an output item.
addByte
public abstract void addByte(String name,
byte val)
- Add a byte item referred by its name. Usually the added item should
be position independent. To minimize any programming error, use
the alias field if the item has multiple occurrence and the
position of the item is important.
- Parameters:
- name - The name of the item to be added.
- val - The byte value to be added.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IllegalMethodException
- Cannot use this method on alias
field.
addShort
public abstract void addShort(String name,
short val)
- Add a short item referred by its name. Usually the added item should
be position independent. To minimize any programming error, use
the alias field if the item has multiple occurrence and the
position of the item is important.
- Parameters:
- name - The name of the item to be added.
- val - The short value to be added.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IllegalMethodException
- Cannot use this method on alias
field.
addInt
public abstract void addInt(String name,
int val)
- Add a int item referred by its name. Usually the added item should
be position independent. To minimize any programming error, use
the alias field if the item has multiple occurrence and the
position of the item is important.
- Parameters:
- name - The name of the item to be added.
- val - The int value to be added.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IllegalMethodException
- Cannot use this method on alias
field.
addFloat
public abstract void addFloat(String name,
float val)
- Add a float item referred by its name. Usually the added item is
position-independent. To minimize any programming error, use
the alias field if the item has multiple occurrence and the
position of the item is important.
- Parameters:
- name - The name of the item to be added.
- val - The float value to be added.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IllegalMethodException
- Cannot use this method on alias
field.
addDouble
public abstract void addDouble(String name,
double val)
- Add a double item referred by its name. Usually the added item
is position-independent. To minimize any programming error,
use the alias field if the item has multiple occurrence and the
position of the item is important.
- Parameters:
- name - The name of the item to be added.
- val - The double value to be added.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IllegalMethodException
- Cannot use this method on alias
field.
addString
public abstract void addString(String name,
String val)
- Add a string item referred by its name. Usually the added item
is position-independent. To minimize programming errors,
use the alias field if the item has multiple occurrences and the
position of the item is important.
- Parameters:
- name - The name of the item to be added.
- val - The string value to be added.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IllegalMethodException
- Cannot use this method on alias
field.
addBytes
public abstract void addBytes(String name,
byte val[],
int len)
- Add a byte-array item referred by its name. Usually the added item
should be position independent. To minimize any programming error,
use the alias field if the item has multiple occurrence and the
position of the item is important.
- Parameters:
- name - The name of the item to be added.
- val - The byte-array value to be added.
- len - The number of bytes to be added.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IllegalMethodException
- Cannot use this method on alias
field.
setByteItem
public abstract void setByteItem(String name,
int itemNo,
byte val)
- Change the byte value of an occurrence of the named item. The
occurrence number starts at 0. If the item doesn't exist, it
will be added. All prior non-existing instances will be added with
a null default value.
- Parameters:
- name - The name of the item.
- itemNo - The occurrence number.
- val - The byte value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
setShortItem
public abstract void setShortItem(String name,
int itemNo,
short val)
- Change the short value of an occurrence of the named item. The
occurrence number starts at 0. If the item doesn't exist, it
will be added. All prior non-existing instances will be added with
default value of 0.
- Parameters:
- name - The name of the item.
- itemNo - The occurrence number.
- val - The short value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
setIntItem
public abstract void setIntItem(String name,
int itemNo,
int val)
- Change the int value of an occurrence of the named item. The
occurrence number starts at 0. If the item doesn't exist, it
will be added. All prior non-existing instances will be added with
default 0 value.
- Parameters:
- name - The name of the item.
- itemNo - The occurrence number.
- val - The int value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
setFloatItem
public abstract void setFloatItem(String name,
int itemNo,
float val)
- Change the float value of an occurrence of the named item. The
occurrence number starts at 0. If the item doesn't exist, it
will be added. All prior non-existing instances will be inserted
with default value of 0.0.
- Parameters:
- name - The name of the item.
- itemNo - The occurrence number.
- val - The float value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
setDoubleItem
public abstract void setDoubleItem(String name,
int itemNo,
double val)
- Change the double value of an occurrence of the named item. The
occurrence number starts at 0. If the item doesn't exist, it
will be added. All prior non-existing instances will be inserted
with default value 0.0.
- Parameters:
- name - The name of the item.
- itemNo - The occurrence number.
- val - The double value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
setStringItem
public abstract void setStringItem(String name,
int itemNo,
String val)
- Change the string value of an occurrence of the named item. The
occurrence number starts at 0. If the item doesn't exist, it
will be added. All prior non-existing instances will be added with
default "" value.
- Parameters:
- name - The name of the item.
- itemNo - The occurrence number.
- val - The string value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
setBytesItem
public abstract void setBytesItem(String name,
int itemNo,
byte val[],
int len)
- Change the byte-array value of an occurrence of the named item. The
occurrence number starts at 0. If the item doesn't exist, it
will be added. All prior non-existing instances will be inserted
with default null value.
- Parameters:
- name - The name of the item.
- itemNo - The occurrence number.
- val - The byte-array value.
- len - The length of the byte-array.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
delete
public abstract void delete(String name)
- Delete the first item with the matching name.
- Parameters:
- name - The name of the item to be deleted.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- Cannot delete an input item.
deleteItem
public abstract void deleteItem(String name,
int itemNo)
- Delete an occurrence of an item referred by its name. The
occurrence starts at 0.
- Parameters:
- name - The name of the item to be deleted.
- itemNo - Occurrence number of the item.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- Cannot delete an input item.
- Throws: IndexOutOfBoundsException
- The itemNo for an alias field
is not 0.
getOccurrenceCount
public abstract int getOccurrenceCount(String name)
- Get the number of occurrence of a named item.
- Parameters:
- name - The name of the item.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is not an output item.
getByteItemDef
public abstract byte getByteItemDef(String name,
int itemNo,
byte def)
- Get an occurrence of a named item of byte data type. The
occurrence starts from 0. If it doesn't exist, the default value
will be returned.
- Parameters:
- name - Name of the item.
- itemNo - Occurrence number of the item.
- def - Default value.
- Returns:
- A byte value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IndexOutOfBoundsException
- The itemNo for an alias field
is not 0.
getShortItemDef
public abstract short getShortItemDef(String name,
int itemNo,
short def)
- Get an occurrence of a named item of short data type. The
occurrence starts from 0. If it doesn't exist, the default value
will be returned.
- Parameters:
- name - Name of the item.
- itemNo - Occurrence number of the item.
- def - Default value.
- Returns:
- A short value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IndexOutOfBoundsException
- The itemNo for an alias field
is not 0.
getIntItemDef
public abstract int getIntItemDef(String name,
int itemNo,
int def)
- Get an occurrence of a named item of int data type. The
occurrence starts from 0. If it doesn't exist, the default value
will be returned.
- Parameters:
- name - Name of the item.
- itemNo - Occurrence number of the item.
- def - Default value.
- Returns:
- An int value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IndexOutOfBoundsException
- The itemNo for an alias field
is not 0.
getFloatItemDef
public abstract float getFloatItemDef(String name,
int itemNo,
float def)
- Get an occurrence of a named item of float data type. The
occurrence starts from 0. If it doesn't exist, the default value
will be returned.
- Parameters:
- name - Name of the item.
- itemNo - Occurrence number of the item.
- def - Default value.
- Returns:
- A float value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IndexOutOfBoundsException
- The itemNo for an alias field
is not 0.
getDoubleItemDef
public abstract double getDoubleItemDef(String name,
int itemNo,
double def)
- Get an occurrence of a named item of double data type. The
occurrence starts from 0. If it doesn't exist, the default value
will be returned.
- Parameters:
- name - Name of the item.
- itemNo - Occurrence number of the item.
- def - Default value.
- Returns:
- A double value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IndexOutOfBoundsException
- The itemNo for an alias field
is not 0.
getStringItemDef
public abstract String getStringItemDef(String name,
int itemNo,
String def)
- Get an occurrence of a named item of string data type. The
occurrence starts from 0. If it doesn't exist, the default value
will be returned.
- Parameters:
- name - Name of the item.
- itemNo - Occurrence number of the item.
- def - Default value.
- Returns:
- A string value.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IndexOutOfBoundsException
- The itemNo for an alias field
is not 0.
getBytesItemDef
public abstract byte[] getBytesItemDef(String name,
int itemNo,
byte def[])
- Get an occurrence of a named item of byte-array data type. The
occurrence starts from 0. If it doesn't exist, the default value
will be returned.
- Parameters:
- name - Name of the item.
- itemNo - Occurrence number of the item.
- def - Default value.
- Returns:
- A byte-array object.
- Throws: NoSuchFieldError
- It is an invalid name.
- Throws: IllegalAccessError
- It is an output item.
- Throws: IndexOutOfBoundsException
- The itemNo for an alias field
is not 0.
All Packages Class Hierarchy This Package Previous Next Index