public interface ITable
Modifier and Type | Field and Description |
---|---|
static int |
NOTIFY_DELETE |
static int |
NOTIFY_FLAGS |
static int |
NOTIFY_IMMEDIATE
Notifier flag values.
|
static int |
NOTIFY_LOCAL |
static int |
NOTIFY_NEW |
static int |
NOTIFY_UPDATE |
Modifier and Type | Method and Description |
---|---|
void |
addSubTableListener(ITableListener listener)
This will immediately notify the listener of all current sub tables
|
void |
addSubTableListener(ITableListener listener,
boolean localNotify)
This will immediately notify the listener of all current sub tables
|
void |
addTableListener(ITableListener listener)
Add a listener for changes to the table
|
void |
addTableListener(ITableListener listener,
boolean immediateNotify)
Add a listener for changes to the table
|
void |
addTableListener(java.lang.String key,
ITableListener listener,
boolean immediateNotify)
Add a listener for changes to a specific key the table
|
void |
addTableListenerEx(ITableListener listener,
int flags)
Add a listener for changes to the table
|
void |
addTableListenerEx(java.lang.String key,
ITableListener listener,
int flags)
Add a listener for changes to a specific key the table
|
void |
clearFlags(java.lang.String key,
int flags)
Clears flags on the specified key in this table.
|
void |
clearPersistent(java.lang.String key)
Stop making a key's value persistent through program restarts.
|
boolean |
containsKey(java.lang.String key)
Checks the table and tells if it contains the specified key
|
boolean |
containsSubTable(java.lang.String key) |
void |
delete(java.lang.String key)
Deletes the specified key in this table.
|
boolean |
getBoolean(java.lang.String key)
Deprecated.
This exception-raising method has been replaced by the
default-taking method
getBoolean(String, boolean) . |
boolean |
getBoolean(java.lang.String key,
boolean defaultValue)
Returns the boolean the key maps to.
|
boolean[] |
getBooleanArray(java.lang.String key)
Deprecated.
This exception-raising method has been replaced by the
default-taking method
getBooleanArray(String, boolean[]) . |
boolean[] |
getBooleanArray(java.lang.String key,
boolean[] defaultValue)
Returns the boolean array the key maps to.
|
java.lang.Boolean[] |
getBooleanArray(java.lang.String key,
java.lang.Boolean[] defaultValue)
Returns the boolean array the key maps to.
|
double |
getDouble(java.lang.String key)
Deprecated.
Use
getNumber(String, double) instead. |
double |
getDouble(java.lang.String key,
double defaultValue)
Deprecated.
Use
getNumber(String, double) instead. |
int |
getFlags(java.lang.String key)
Returns the flags for the specified key.
|
int |
getInt(java.lang.String key)
Deprecated.
Use
getNumber(String, double) instead. |
int |
getInt(java.lang.String key,
int defaultValue)
Deprecated.
Use
getNumber(String, double) instead. |
java.util.Set<java.lang.String> |
getKeys() |
java.util.Set<java.lang.String> |
getKeys(int types) |
double |
getNumber(java.lang.String key)
Deprecated.
This exception-raising method has been replaced by the
default-taking method
getNumber(String, double) . |
double |
getNumber(java.lang.String key,
double defaultValue)
Returns the number the key maps to.
|
double[] |
getNumberArray(java.lang.String key)
Deprecated.
This exception-raising method has been replaced by the
default-taking method
getNumberArray(String, double[]) . |
double[] |
getNumberArray(java.lang.String key,
double[] defaultValue)
Returns the number array the key maps to.
|
java.lang.Double[] |
getNumberArray(java.lang.String key,
java.lang.Double[] defaultValue)
Returns the number array the key maps to.
|
byte[] |
getRaw(java.lang.String key)
Deprecated.
This exception-raising method has been replaced by the
default-taking method
getRaw(String, byte[]) . |
byte[] |
getRaw(java.lang.String key,
byte[] defaultValue)
Returns the raw value (byte array) the key maps to.
|
java.lang.String |
getString(java.lang.String key)
Deprecated.
This exception-raising method has been replaced by the
default-taking method
getString(String, String) . |
java.lang.String |
getString(java.lang.String key,
java.lang.String defaultValue)
Returns the string the key maps to.
|
java.lang.String[] |
getStringArray(java.lang.String key)
Deprecated.
This exception-raising method has been replaced by the
default-taking method
getStringArray(String, String[]) . |
java.lang.String[] |
getStringArray(java.lang.String key,
java.lang.String[] defaultValue)
Returns the string array the key maps to.
|
ITable |
getSubTable(java.lang.String key)
Returns the table at the specified key.
|
java.util.Set<java.lang.String> |
getSubTables() |
java.lang.Object |
getValue(java.lang.String key)
Deprecated.
This exception-raising method has been replaced by the
default-taking method
getValue(String, Object) . |
java.lang.Object |
getValue(java.lang.String key,
java.lang.Object defaultValue)
Gets the value associated with a key as an object.
|
boolean |
isPersistent(java.lang.String key)
Returns whether the value is persistent through program restarts.
|
boolean |
putBoolean(java.lang.String key,
boolean value)
Put a boolean in the table
|
boolean |
putBooleanArray(java.lang.String key,
boolean[] value)
Put a boolean array in the table
|
boolean |
putBooleanArray(java.lang.String key,
java.lang.Boolean[] value)
Put a boolean array in the table
|
boolean |
putDouble(java.lang.String key,
double value)
Deprecated.
Use
putNumber(String, double) instead. |
boolean |
putInt(java.lang.String key,
int value)
Deprecated.
Use
putNumber(String, double) instead. |
boolean |
putNumber(java.lang.String key,
double value)
Put a number in the table
|
boolean |
putNumberArray(java.lang.String key,
double[] value)
Put a number array in the table
|
boolean |
putNumberArray(java.lang.String key,
java.lang.Double[] value)
Put a number array in the table
|
boolean |
putRaw(java.lang.String key,
byte[] value)
Put a raw value (byte array) in the table
|
boolean |
putRaw(java.lang.String key,
java.nio.ByteBuffer value,
int len)
Put a raw value (bytes from a byte buffer) in the table
|
boolean |
putString(java.lang.String key,
java.lang.String value)
Put a string in the table
|
boolean |
putStringArray(java.lang.String key,
java.lang.String[] value)
Put a string array in the table
|
boolean |
putValue(java.lang.String key,
java.lang.Object value)
Put a value in the table
|
void |
removeTableListener(ITableListener listener)
Remove a listener from receiving table events
|
void |
retrieveValue(java.lang.String key,
java.lang.Object externalValue)
Deprecated.
Use get*Array functions instead.
|
boolean |
setDefaultBoolean(java.lang.String key,
boolean defaultValue)
Gets the current value in the table, setting it if it does not exist.
|
boolean |
setDefaultBooleanArray(java.lang.String key,
boolean[] defaultValue)
Gets the current value in the table, setting it if it does not exist.
|
boolean |
setDefaultBooleanArray(java.lang.String key,
java.lang.Boolean[] defaultValue)
Gets the current value in the table, setting it if it does not exist.
|
boolean |
setDefaultNumber(java.lang.String key,
double defaultValue)
Gets the current value in the table, setting it if it does not exist.
|
boolean |
setDefaultNumberArray(java.lang.String key,
double[] defaultValue)
Gets the current value in the table, setting it if it does not exist.
|
boolean |
setDefaultNumberArray(java.lang.String key,
java.lang.Double[] defaultValue)
Gets the current value in the table, setting it if it does not exist.
|
boolean |
setDefaultRaw(java.lang.String key,
byte[] defaultValue)
Gets the current value in the table, setting it if it does not exist.
|
boolean |
setDefaultString(java.lang.String key,
java.lang.String defaultValue)
Gets the current value in the table, setting it if it does not exist.
|
boolean |
setDefaultStringArray(java.lang.String key,
java.lang.String[] defaultValue)
Gets the current value in the table, setting it if it does not exist.
|
void |
setFlags(java.lang.String key,
int flags)
Sets flags on the specified key in this table.
|
void |
setPersistent(java.lang.String key)
Makes a key's value persistent through program restarts.
|
static final int NOTIFY_IMMEDIATE
static final int NOTIFY_LOCAL
static final int NOTIFY_NEW
static final int NOTIFY_DELETE
static final int NOTIFY_UPDATE
static final int NOTIFY_FLAGS
boolean containsKey(java.lang.String key)
key
- the key to search forboolean containsSubTable(java.lang.String key)
key
- the key to search forITable getSubTable(java.lang.String key)
key
- the name of the table relative to this onejava.util.Set<java.lang.String> getKeys(int types)
types
- bitmask of types; 0 is treated as a "don't care".java.util.Set<java.lang.String> getKeys()
java.util.Set<java.lang.String> getSubTables()
void setPersistent(java.lang.String key)
key
- the key namevoid clearPersistent(java.lang.String key)
key
- the key nameboolean isPersistent(java.lang.String key)
key
- the key namevoid setFlags(java.lang.String key, int flags)
key
- the key nameflags
- the flags to set (bitmask)void clearFlags(java.lang.String key, int flags)
key
- the key nameflags
- the flags to clear (bitmask)int getFlags(java.lang.String key)
key
- the key namevoid delete(java.lang.String key)
key
- the key name@Deprecated java.lang.Object getValue(java.lang.String key) throws TableKeyNotDefinedException
getValue(String, Object)
.getDouble(String, double)
.key
- the key of the value to look upTableKeyNotDefinedException
- if there is no value associated with
the given keyjava.lang.Object getValue(java.lang.String key, java.lang.Object defaultValue)
getDouble(String, double)
.key
- the key of the value to look updefaultValue
- the default value if the key is nullboolean putValue(java.lang.String key, java.lang.Object value) throws java.lang.IllegalArgumentException
key
- the key to be assigned tovalue
- the value that will be assignedjava.lang.IllegalArgumentException
- when the value is not supported by the
table@Deprecated void retrieveValue(java.lang.String key, java.lang.Object externalValue) throws TableKeyNotDefinedException
key
- the key to be assigned toexternalValue
- the array data type to retreive intoTableKeyNotDefinedException
- if there is no value associated with
the given keyboolean putNumber(java.lang.String key, double value)
key
- the key to be assigned tovalue
- the value that will be assignedboolean setDefaultNumber(java.lang.String key, double defaultValue)
key
- the keydefaultValue
- the default value to set if key doens't exist.@Deprecated double getNumber(java.lang.String key) throws TableKeyNotDefinedException
getNumber(String, double)
.key
- the key to look upTableKeyNotDefinedException
- if there is no value associated with
the given keydouble getNumber(java.lang.String key, double defaultValue)
key
- the key to look updefaultValue
- the value to be returned if no value is foundboolean putString(java.lang.String key, java.lang.String value)
key
- the key to be assigned tovalue
- the value that will be assignedboolean setDefaultString(java.lang.String key, java.lang.String defaultValue)
key
- the keydefaultValue
- the default value to set if key doens't exist.@Deprecated java.lang.String getString(java.lang.String key) throws TableKeyNotDefinedException
getString(String, String)
.key
- the key to look upTableKeyNotDefinedException
- if there is no value associated with
the given keyjava.lang.String getString(java.lang.String key, java.lang.String defaultValue)
key
- the key to look updefaultValue
- the value to be returned if no value is foundboolean putBoolean(java.lang.String key, boolean value)
key
- the key to be assigned tovalue
- the value that will be assignedboolean setDefaultBoolean(java.lang.String key, boolean defaultValue)
key
- the keydefaultValue
- the default value to set if key doens't exist.@Deprecated boolean getBoolean(java.lang.String key) throws TableKeyNotDefinedException
getBoolean(String, boolean)
.key
- the key to look upTableKeyNotDefinedException
- if there is no value associated with
the given keyboolean getBoolean(java.lang.String key, boolean defaultValue)
key
- the key to look updefaultValue
- the value to be returned if no value is foundboolean putBooleanArray(java.lang.String key, boolean[] value)
key
- the key to be assigned tovalue
- the value that will be assignedboolean setDefaultBooleanArray(java.lang.String key, boolean[] defaultValue)
key
- the keydefaultValue
- the default value to set if key doens't exist.boolean putBooleanArray(java.lang.String key, java.lang.Boolean[] value)
key
- the key to be assigned tovalue
- the value that will be assignedboolean setDefaultBooleanArray(java.lang.String key, java.lang.Boolean[] defaultValue)
key
- the keydefaultValue
- the default value to set if key doens't exist.@Deprecated boolean[] getBooleanArray(java.lang.String key) throws TableKeyNotDefinedException
getBooleanArray(String, boolean[])
.key
- the key to look upTableKeyNotDefinedException
- if there is no value associated with
the given keyboolean[] getBooleanArray(java.lang.String key, boolean[] defaultValue)
key
- the key to look updefaultValue
- the value to be returned if no value is foundjava.lang.Boolean[] getBooleanArray(java.lang.String key, java.lang.Boolean[] defaultValue)
key
- the key to look updefaultValue
- the value to be returned if no value is foundboolean putNumberArray(java.lang.String key, double[] value)
key
- the key to be assigned tovalue
- the value that will be assignedboolean setDefaultNumberArray(java.lang.String key, double[] defaultValue)
key
- the keydefaultValue
- the default value to set if key doens't exist.boolean putNumberArray(java.lang.String key, java.lang.Double[] value)
key
- the key to be assigned tovalue
- the value that will be assignedboolean setDefaultNumberArray(java.lang.String key, java.lang.Double[] defaultValue)
key
- the keydefaultValue
- the default value to set if key doens't exist.@Deprecated double[] getNumberArray(java.lang.String key) throws TableKeyNotDefinedException
getNumberArray(String, double[])
.key
- the key to look upTableKeyNotDefinedException
- if there is no value associated with
the given keydouble[] getNumberArray(java.lang.String key, double[] defaultValue)
key
- the key to look updefaultValue
- the value to be returned if no value is foundjava.lang.Double[] getNumberArray(java.lang.String key, java.lang.Double[] defaultValue)
key
- the key to look updefaultValue
- the value to be returned if no value is foundboolean putStringArray(java.lang.String key, java.lang.String[] value)
key
- the key to be assigned tovalue
- the value that will be assignedboolean setDefaultStringArray(java.lang.String key, java.lang.String[] defaultValue)
key
- the keydefaultValue
- the default value to set if key doens't exist.@Deprecated java.lang.String[] getStringArray(java.lang.String key) throws TableKeyNotDefinedException
getStringArray(String, String[])
.key
- the key to look upTableKeyNotDefinedException
- if there is no value associated with
the given keyjava.lang.String[] getStringArray(java.lang.String key, java.lang.String[] defaultValue)
key
- the key to look updefaultValue
- the value to be returned if no value is foundboolean putRaw(java.lang.String key, byte[] value)
key
- the key to be assigned tovalue
- the value that will be assignedboolean setDefaultRaw(java.lang.String key, byte[] defaultValue)
key
- the keydefaultValue
- the default value to set if key doens't exist.boolean putRaw(java.lang.String key, java.nio.ByteBuffer value, int len)
key
- the key to be assigned tovalue
- the value that will be assignedlen
- the length of the value@Deprecated byte[] getRaw(java.lang.String key) throws TableKeyNotDefinedException
getRaw(String, byte[])
.key
- the key to look upTableKeyNotDefinedException
- if there is no value associated with
the given keybyte[] getRaw(java.lang.String key, byte[] defaultValue)
key
- the key to look updefaultValue
- the value to be returned if no value is foundvoid addTableListener(ITableListener listener)
listener
- the listener to addvoid addTableListener(ITableListener listener, boolean immediateNotify)
listener
- the listener to addimmediateNotify
- if true then this listener will be notified of all
current entries (marked as new)void addTableListenerEx(ITableListener listener, int flags)
listener
- the listener to addflags
- bitmask specifying desired notificationsvoid addTableListener(java.lang.String key, ITableListener listener, boolean immediateNotify)
key
- the key to listen forlistener
- the listener to addimmediateNotify
- if true then this listener will be notified of all
current entries (marked as new)void addTableListenerEx(java.lang.String key, ITableListener listener, int flags)
key
- the key to listen forlistener
- the listener to addflags
- bitmask specifying desired notificationsvoid addSubTableListener(ITableListener listener)
listener
- the listener to notifyvoid addSubTableListener(ITableListener listener, boolean localNotify)
listener
- the listener to notifylocalNotify
- if true then this listener will be notified of all
local changes in addition to all remote changesvoid removeTableListener(ITableListener listener)
listener
- the listener to be removed@Deprecated boolean putInt(java.lang.String key, int value)
putNumber(String, double)
instead.key
- the keyvalue
- the valuejava.lang.IllegalArgumentException
- if key is null@Deprecated int getInt(java.lang.String key) throws TableKeyNotDefinedException
getNumber(String, double)
instead.key
- the keyTableKeyNotDefinedException
- if there is no value mapped to by the
keyjava.lang.IllegalArgumentException
- if the value mapped to by the key is not
an intjava.lang.IllegalArgumentException
- if the key is null@Deprecated int getInt(java.lang.String key, int defaultValue) throws TableKeyNotDefinedException
getNumber(String, double)
instead.key
- the keydefaultValue
- the value returned if the key is undefinedjava.lang.IllegalArgumentException
- if the value mapped to by the key is not
an intjava.lang.IllegalArgumentException
- if the key is nullTableKeyNotDefinedException
@Deprecated boolean putDouble(java.lang.String key, double value)
putNumber(String, double)
instead.key
- the keyvalue
- the valuejava.lang.IllegalArgumentException
- if key is null@Deprecated double getDouble(java.lang.String key) throws TableKeyNotDefinedException
getNumber(String, double)
instead.key
- the keyTableKeyNotDefinedException
- if there is no
value mapped to by the keyjava.lang.IllegalArgumentException
- if the value mapped to by the key is not a
doublejava.lang.IllegalArgumentException
- if the key is null@Deprecated double getDouble(java.lang.String key, double defaultValue)
getNumber(String, double)
instead.key
- the keydefaultValue
- the value returned if the key is undefinedjava.lang.IllegalArgumentException
- if the value mapped to by the key is not a
doublejava.lang.IllegalArgumentException
- if the key is null