|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectbea.jolt.JoltMessage
This class encapsulates the attribute-value pair data for the application protocol. This class allows the user to add an input attribute (which should not be position-dependent), set an input attribute (single occurrence or position-independent), delete an input attribute, or get an output attribute from the message.
JoltRemoteService,
JoltReply| 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 an 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 |
addMessage(java.lang.String name,
JoltMessage val)
Add a message 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 object. |
void |
delete(java.lang.String name)
Delete the first item with the matching name. |
void |
deleteItem(java.lang.String name,
int itemNo)
Delete an instance of an item referred by its name. |
void |
enableAccessCheck(boolean enable)
Enable (default) or disable the checking for access (read-only or write-only). |
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. |
JoltDefinition |
getDefinition()
Get the message definition. |
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. |
java.util.Hashtable |
getHashTable()
Get the table that stores the values. |
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. |
JoltMessage |
getMessageDef(java.lang.String name,
JoltMessage def)
Get the first item based on its name. |
JoltMessage |
getMessageItemDef(java.lang.String name,
int itemNo,
JoltMessage def)
Get an occurrence of a named item of the JoltMessage data type. |
java.util.Enumeration |
getNames()
Get the field names in the message. |
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 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 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 |
setMessage(java.lang.String name,
JoltMessage val)
Change the value for the first instance of the named item of JoltMessage data type. |
void |
setMessageItem(java.lang.String name,
int itemNo,
JoltMessage val)
Change the message object 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 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. |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Method Detail |
public void clear()
clear in interface Messagepublic void enableAccessCheck(boolean enable)
enable - true to enable the checking; otherwise, false.
public void addByte(java.lang.String name,
byte val)
addByte in interface Messagename - 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 an alias
field.
public void addShort(java.lang.String name,
short val)
addShort in interface Messagename - 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 an alias
field.
public void addInt(java.lang.String name,
int val)
addInt in interface Messagename - 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 an alias
field.
public void addFloat(java.lang.String name,
float val)
addFloat in interface Messagename - 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 an alias
field.
public void addDouble(java.lang.String name,
double val)
addDouble in interface Messagename - 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 an alias
field.
public void addString(java.lang.String name,
java.lang.String val)
addString in interface Messagename - 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 an alias
field.
public void addMessage(java.lang.String name,
JoltMessage val)
name - The name of the item to be added.val - The message 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 an alias
field.
public void addBytes(java.lang.String name,
byte[] val,
int len)
addBytes in interface Messagename - 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 an alias
field.
public void addMBString(java.lang.String name,
java.lang.String val)
addMBString in interface Messagename - 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 an alias
field.
public void setByte(java.lang.String name,
byte val)
setByte in interface Messagename - 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)
setShort in interface Messagename - 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)
setInt in interface Messagename - 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)
setFloat in interface Messagename - 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)
setDouble in interface Messagename - 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)
setString in interface Messagename - 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 setMessage(java.lang.String name,
JoltMessage val)
name - The name of the item to be set or changed.val - The message 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)
setBytes in interface Messagename - 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)
setMBString in interface Messagename - 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 setByteItem(java.lang.String name,
int itemNo,
byte val)
setByteItem in interface Messagename - 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)
setShortItem in interface Messagename - 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)
setIntItem in interface Messagename - 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)
setFloatItem in interface Messagename - 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)
setDoubleItem in interface Messagename - 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)
setStringItem in interface Messagename - 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 setMessageItem(java.lang.String name,
int itemNo,
JoltMessage val)
name - The name of the item.itemNo - The occurrence number.val - The message object.
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)
setBytesItem in interface Messagename - 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)
setMBStringItem in interface Messagename - 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 int getOccurrenceCount(java.lang.String name)
getOccurrenceCount in interface Messagename - The name of the item.
java.lang.NoSuchFieldError - It is an invalid name.
java.lang.IllegalAccessError - It is not an output item.
public byte getByteDef(java.lang.String name,
byte def)
getByteDef in interface Messagename - 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)
getShortDef in interface Messagename - 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)
getIntDef in interface Messagename - 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)
getFloatDef in interface Messagename - 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)
getDoubleDef in interface Messagename - 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)
getStringDef in interface Messagename - 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 JoltMessage getMessageDef(java.lang.String name,
JoltMessage def)
name - The name of the item.def - The default Message object.
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)
getBytesDef in interface Messagename - 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)
getMBStringDef in interface Messagename - 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 byte getByteItemDef(java.lang.String name,
int itemNo,
byte def)
getByteItemDef in interface Messagename - 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)
getShortItemDef in interface Messagename - 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)
getIntItemDef in interface Messagename - 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)
getFloatItemDef in interface Messagename - 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)
getDoubleItemDef in interface Messagename - 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)
getStringItemDef in interface Messagename - 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 JoltMessage getMessageItemDef(java.lang.String name,
int itemNo,
JoltMessage 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)
getBytesItemDef in interface Messagename - 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)
getMBStringItemDef in interface Messagename - 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 void delete(java.lang.String name)
delete in interface Messagename - 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)
deleteItem in interface Messagename - The name of the item to be deleted.itemNo - The occurrence number.
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 JoltDefinition getDefinition()
public java.util.Enumeration getNames()
public java.util.Hashtable getHashTable()
public java.lang.String toString()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||