|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
This interface provides the set, get, add, and delete methods to interact with any instance of an item in the message object.
| Method Summary | |
void |
addByte(java.lang.String name,
byte val)
Add a byte item referred by its name. |
void |
addBytes(java.lang.String name,
byte[] val,
int len)
Add a byte-array item referred by its name. |
void |
addDouble(java.lang.String name,
double val)
Add a double item referred by its name. |
void |
addFloat(java.lang.String name,
float val)
Add a float item referred by its name. |
void |
addInt(java.lang.String name,
int val)
Add a int item referred by its name. |
void |
addMBString(java.lang.String name,
java.lang.String val)
Add a mbstring item referred by its name. |
void |
addShort(java.lang.String name,
short val)
Add a short item referred by its name. |
void |
addString(java.lang.String name,
java.lang.String val)
Add a string item referred by its name. |
void |
clear()
Remove all items from the message. |
void |
delete(java.lang.String name)
Delete the first item with the matching name. |
void |
deleteItem(java.lang.String name,
int itemNo)
Delete an occurrence of an item referred by its name. |
byte |
getByteDef(java.lang.String name,
byte def)
Get the first item based on its name. |
byte |
getByteItemDef(java.lang.String name,
int itemNo,
byte def)
Get an occurrence of a named item of byte data type. |
byte[] |
getBytesDef(java.lang.String name,
byte[] def)
Get the first item based on its name. |
byte[] |
getBytesItemDef(java.lang.String name,
int itemNo,
byte[] def)
Get an occurrence of a named item of byte-array data type. |
double |
getDoubleDef(java.lang.String name,
double def)
Get the first item based on its name. |
double |
getDoubleItemDef(java.lang.String name,
int itemNo,
double def)
Get an occurrence of a named item of double data type. |
float |
getFloatDef(java.lang.String name,
float def)
Get the first item based on its name. |
float |
getFloatItemDef(java.lang.String name,
int itemNo,
float def)
Get an occurrence of a named item of float data type. |
int |
getIntDef(java.lang.String name,
int def)
Get the first item based on its name. |
int |
getIntItemDef(java.lang.String name,
int itemNo,
int def)
Get an occurrence of a named item of int data type. |
java.lang.String |
getMBStringDef(java.lang.String name,
java.lang.String def)
Get the first item based on its name. |
java.lang.String |
getMBStringItemDef(java.lang.String name,
int itemNo,
java.lang.String def)
Get an occurrence of a named item of mbstring data type. |
int |
getOccurrenceCount(java.lang.String name)
Get the number of occurrence of a named item. |
short |
getShortDef(java.lang.String name,
short def)
Get the first item based on its name. |
short |
getShortItemDef(java.lang.String name,
int itemNo,
short def)
Get an occurrence of a named item of short data type. |
java.lang.String |
getStringDef(java.lang.String name,
java.lang.String def)
Get the first item based on its name. |
java.lang.String |
getStringItemDef(java.lang.String name,
int itemNo,
java.lang.String def)
Get an occurrence of a named item of string data type. |
void |
setByte(java.lang.String name,
byte val)
Change the value for the first instance of the named item of byte data type. |
void |
setByteItem(java.lang.String name,
int itemNo,
byte val)
Change the byte value of an occurrence of the named item. |
void |
setBytes(java.lang.String name,
byte[] val,
int len)
Change the value for the first instance of the named item of byte-array data type. |
void |
setBytesItem(java.lang.String name,
int itemNo,
byte[] val,
int len)
Change the byte-array value of an occurrence of the named item. |
void |
setDouble(java.lang.String name,
double val)
Change the value for the first instance of the named item of a double data type. |
void |
setDoubleItem(java.lang.String name,
int itemNo,
double val)
Change the double value of an occurrence of the named item. |
void |
setFloat(java.lang.String name,
float val)
Change the value for the first instance of the named item of a float data type. |
void |
setFloatItem(java.lang.String name,
int itemNo,
float val)
Change the float value of an occurrence of the named item. |
void |
setInt(java.lang.String name,
int val)
Change the value for the first instance of the named item of an int data type. |
void |
setIntItem(java.lang.String name,
int itemNo,
int val)
Change the int value of an occurrence of the named item. |
void |
setMBString(java.lang.String name,
java.lang.String val)
Change the value for the first instance of the named item of a mbstring data type. |
void |
setMBStringItem(java.lang.String name,
int itemNo,
java.lang.String val)
Change the mbstring value of an occurrence of the named item. |
void |
setShort(java.lang.String name,
short val)
Change the value for the first instance of the named item of a short data type. |
void |
setShortItem(java.lang.String name,
int itemNo,
short val)
Change the short value of an occurrence of the named item. |
void |
setString(java.lang.String name,
java.lang.String val)
Change the value for the first instance of the named item of a string data type. |
void |
setStringItem(java.lang.String name,
int itemNo,
java.lang.String val)
Change the string value of an occurrence of the named item. |
| Method Detail |
public void clear()
public void setByte(java.lang.String name,
byte val)
name - The name of the item to be set or changed.val - The byte value to be set or changed to.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setShort(java.lang.String name,
short val)
name - The name of the item to be set or changed.val - The short value to be set or changed to.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setInt(java.lang.String name,
int val)
name - The name of the item to be set or changed.val - The int value to be set or changed to.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setFloat(java.lang.String name,
float val)
name - The name of the item to be set or changed.val - The float value to be set or changed to.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setDouble(java.lang.String name,
double val)
name - The name of the item to be set or changed.val - The double value to be set or changed to.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setString(java.lang.String name,
java.lang.String val)
name - The name of the item to be set or changed.val - The string value to be set or changed to.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setBytes(java.lang.String name,
byte[] val,
int len)
name - The name of the item to be set or changed.val - The byte-array value to be set or changed to.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setMBString(java.lang.String name,
java.lang.String val)
name - The name of the item to be set or changed.val - The mbstring value to be set or changed to.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public byte getByteDef(java.lang.String name,
byte def)
name - The name of the item.def - The default byte value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is not an output item.
public short getShortDef(java.lang.String name,
short def)
name - The name of the item.def - The default short value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is not an output item.
public int getIntDef(java.lang.String name,
int def)
name - The name of the item.def - The default int value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is not an output item.
public float getFloatDef(java.lang.String name,
float def)
name - The name of the item.def - The default float value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is not an output item.
public double getDoubleDef(java.lang.String name,
double def)
name - The name of the item.def - The default double value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is not an output item.
public java.lang.String getStringDef(java.lang.String name,
java.lang.String def)
name - The name of the item.def - The default string value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is not an output item.
public byte[] getBytesDef(java.lang.String name,
byte[] def)
name - The name of the item.def - The default byte-array value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is not an output item.
public java.lang.String getMBStringDef(java.lang.String name,
java.lang.String def)
name - The name of the item.def - The default mbstring value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is not an output item.
public void addByte(java.lang.String name,
byte val)
name - The name of the item to be added.val - The byte value to be added.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
IllegalMethodException - Cannot use this method on alias
field.
public void addShort(java.lang.String name,
short val)
name - The name of the item to be added.val - The short value to be added.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
IllegalMethodException - Cannot use this method on alias
field.
public void addInt(java.lang.String name,
int val)
name - The name of the item to be added.val - The int value to be added.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
IllegalMethodException - Cannot use this method on alias
field.
public void addFloat(java.lang.String name,
float val)
name - The name of the item to be added.val - The float value to be added.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
IllegalMethodException - Cannot use this method on alias
field.
public void addDouble(java.lang.String name,
double val)
name - The name of the item to be added.val - The double value to be added.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
IllegalMethodException - Cannot use this method on alias
field.
public void addString(java.lang.String name,
java.lang.String val)
name - The name of the item to be added.val - The string value to be added.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
IllegalMethodException - Cannot use this method on alias
field.
public void addBytes(java.lang.String name,
byte[] val,
int len)
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.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
IllegalMethodException - Cannot use this method on alias
field.
public void addMBString(java.lang.String name,
java.lang.String val)
name - The name of the item to be added.val - The mbstring value to be added.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
IllegalMethodException - Cannot use this method on alias
field.
public void setByteItem(java.lang.String name,
int itemNo,
byte val)
name - The name of the item.itemNo - The occurrence number.val - The byte value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setShortItem(java.lang.String name,
int itemNo,
short val)
name - The name of the item.itemNo - The occurrence number.val - The short value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setIntItem(java.lang.String name,
int itemNo,
int val)
name - The name of the item.itemNo - The occurrence number.val - The int value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setFloatItem(java.lang.String name,
int itemNo,
float val)
name - The name of the item.itemNo - The occurrence number.val - The float value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setDoubleItem(java.lang.String name,
int itemNo,
double val)
name - The name of the item.itemNo - The occurrence number.val - The double value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setStringItem(java.lang.String name,
int itemNo,
java.lang.String val)
name - The name of the item.itemNo - The occurrence number.val - The string value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setBytesItem(java.lang.String name,
int itemNo,
byte[] val,
int len)
name - The name of the item.itemNo - The occurrence number.val - The byte-array value.len - The length of the byte-array.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
public void setMBStringItem(java.lang.String name,
int itemNo,
java.lang.String val)
name - The name of the item.itemNo - The occurrence number.val - The mbstring value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.public void delete(java.lang.String name)
name - The name of the item to be deleted.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - Cannot delete an input item.
public void deleteItem(java.lang.String name,
int itemNo)
name - The name of the item to be deleted.itemNo - Occurrence number of the item.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - Cannot delete an input item.
java.lang.IndexOutOfBoundsException - The itemNo for an alias field
is not 0.public int getOccurrenceCount(java.lang.String name)
name - The name of the item.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is not an output item.
public byte getByteItemDef(java.lang.String name,
int itemNo,
byte def)
name - Name of the item.itemNo - Occurrence number of the item.def - Default value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
java.lang.IndexOutOfBoundsException - The itemNo for an alias field
is not 0.
public short getShortItemDef(java.lang.String name,
int itemNo,
short def)
name - Name of the item.itemNo - Occurrence number of the item.def - Default value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
java.lang.IndexOutOfBoundsException - The itemNo for an alias field
is not 0.
public int getIntItemDef(java.lang.String name,
int itemNo,
int def)
name - Name of the item.itemNo - Occurrence number of the item.def - Default value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
java.lang.IndexOutOfBoundsException - The itemNo for an alias field
is not 0.
public float getFloatItemDef(java.lang.String name,
int itemNo,
float def)
name - Name of the item.itemNo - Occurrence number of the item.def - Default value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
java.lang.IndexOutOfBoundsException - The itemNo for an alias field
is not 0.
public double getDoubleItemDef(java.lang.String name,
int itemNo,
double def)
name - Name of the item.itemNo - Occurrence number of the item.def - Default value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
java.lang.IndexOutOfBoundsException - The itemNo for an alias field
is not 0.
public java.lang.String getStringItemDef(java.lang.String name,
int itemNo,
java.lang.String def)
name - Name of the item.itemNo - Occurrence number of the item.def - Default value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
java.lang.IndexOutOfBoundsException - The itemNo for an alias field
is not 0.
public byte[] getBytesItemDef(java.lang.String name,
int itemNo,
byte[] def)
name - Name of the item.itemNo - Occurrence number of the item.def - Default value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
java.lang.IndexOutOfBoundsException - The itemNo for an alias field
is not 0.
public java.lang.String getMBStringItemDef(java.lang.String name,
int itemNo,
java.lang.String def)
name - Name of the item.itemNo - Occurrence number of the item.def - Default value.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is an output item.
java.lang.IndexOutOfBoundsException - The itemNo for an alias field
is not 0.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||