public class JoltMessage extends java.lang.Object implements Message
JoltRemoteService
,
JoltReply
Modifier and Type | Method and Description |
---|---|
void |
addBoolean(java.lang.String name,
boolean val)
Add a boolean item referred by its name.
|
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 |
addLong(java.lang.String name,
long val)
Add a long 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).
|
boolean |
getBooleanDef(java.lang.String name,
boolean def)
Get the first item based on its name.
|
boolean |
getBooleanItemDef(java.lang.String name,
int itemNo,
boolean def)
Get an occurrence of a named item of boolean data type.
|
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.
|
long |
getLongDef(java.lang.String name,
long def)
Get the first item based on its name.
|
long |
getLongItemDef(java.lang.String name,
int itemNo,
long def)
Get an occurrence of a named item of long 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.
|
boolean |
includeMBString() |
void |
setBoolean(java.lang.String name,
boolean val)
Change the value for the first instance of the named item
of boolean data type.
|
void |
setBooleanItem(java.lang.String name,
int itemNo,
boolean val)
Change the boolean value of an occurrence of the named item.
|
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 |
setLong(java.lang.String name,
long val)
Change the value for the first instance of the named item
of long data type.
|
void |
setLongItem(java.lang.String name,
int itemNo,
long val)
Change the long 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() |
public void clear()
public void enableAccessCheck(boolean enable)
enable
- true to enable the checking; otherwise, false.public void addBoolean(java.lang.String name, boolean val)
name
- The name of the item to be added.val
- The boolean 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 addByte(java.lang.String name, byte val)
addByte
in interface Message
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 an alias
field.public void addShort(java.lang.String name, short val)
addShort
in interface Message
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 an alias
field.public void addInt(java.lang.String name, int val)
addInt
in interface Message
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 an alias
field.public void addLong(java.lang.String name, long val)
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 Message
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 an alias
field.public void addDouble(java.lang.String name, double val)
addDouble
in interface Message
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 an alias
field.public void addString(java.lang.String name, java.lang.String val)
addString
in interface Message
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 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.DefinitionException
- It is an invalid definitionpublic void addBytes(java.lang.String name, byte[] val, int len)
addBytes
in interface Message
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 an alias
field.public void addMBString(java.lang.String name, java.lang.String val)
addMBString
in interface Message
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 an alias
field.public void setBoolean(java.lang.String name, boolean val)
name
- The name of the item to be set or changed.val
- The boolean 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 setByte(java.lang.String name, byte val)
public void setShort(java.lang.String name, short val)
public void setInt(java.lang.String name, int val)
public void setLong(java.lang.String name, long val)
name
- The name of the item to be set or changed.val
- The long 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)
public void setDouble(java.lang.String name, double val)
public void setString(java.lang.String name, java.lang.String val)
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)
public void setMBString(java.lang.String name, java.lang.String val)
setMBString
in interface Message
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 setBooleanItem(java.lang.String name, int itemNo, boolean val)
name
- The name of the item.itemNo
- The occurrence number.val
- The boolean value.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 Message
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)
setShortItem
in interface Message
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)
setIntItem
in interface Message
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 setLongItem(java.lang.String name, int itemNo, long val)
name
- The name of the item.itemNo
- The occurrence number.val
- The long 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 Message
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)
setDoubleItem
in interface Message
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)
setStringItem
in interface Message
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 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.DefinitionException
- It is not an invalid data typepublic void setBytesItem(java.lang.String name, int itemNo, byte[] val, int len)
setBytesItem
in interface Message
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)
setMBStringItem
in interface Message
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 int getOccurrenceCount(java.lang.String name)
getOccurrenceCount
in interface Message
name
- The name of the item.java.lang.NoSuchFieldError
- It is an invalid name.java.lang.IllegalAccessError
- It is not an output item.public boolean getBooleanDef(java.lang.String name, boolean def)
name
- The name of the item.def
- The default boolean value.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 Message
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)
getShortDef
in interface Message
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)
public long getLongDef(java.lang.String name, long def)
name
- The name of the item.def
- The default long 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 Message
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)
getDoubleDef
in interface Message
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)
getStringDef
in interface Message
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 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 Message
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)
getMBStringDef
in interface Message
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 boolean getBooleanItemDef(java.lang.String name, int itemNo, boolean 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 getByteItemDef(java.lang.String name, int itemNo, byte def)
getByteItemDef
in interface Message
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)
getShortItemDef
in interface Message
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)
getIntItemDef
in interface Message
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 long getLongItemDef(java.lang.String name, int itemNo, long 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)
getFloatItemDef
in interface Message
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)
getDoubleItemDef
in interface Message
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)
getStringItemDef
in interface Message
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 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 Message
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)
getMBStringItemDef
in interface Message
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 void delete(java.lang.String name)
public void deleteItem(java.lang.String name, int itemNo)
deleteItem
in interface Message
name
- 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 boolean includeMBString()
public java.lang.String toString()
toString
in class java.lang.Object