edu.wpi.first.wpilibj.networktables

Class NetworkTable

java.lang.Object

edu.wpi.first.wpilibj.networktables.NetworkTable

All Implemented Interfaces:

IRemote, ITable

public class NetworkTable
extends java.lang.Object
implements ITable, IRemote

A network table that knows its subtable path.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT The default port that network tables operates on
static char	PATH_SEPARATOR The path separator for sub-tables and keys
static int	PERSISTENT The persistent flag value.

Fields inherited from interface edu.wpi.first.wpilibj.tables.ITable

NOTIFY_DELETE, NOTIFY_FLAGS, NOTIFY_IMMEDIATE, NOTIFY_LOCAL, NOTIFY_NEW, NOTIFY_UPDATE

Method Summary

Modifier and Type	Method and Description
void	addConnectionListener(IRemoteConnectionListener listener, boolean immediateNotify) Register an object to listen for connection and disconnection events
static void	addGlobalConnectionListener(IRemoteConnectionListener listener, boolean immediateNotify)
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.
static ConnectionInfo[]	connections()
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.
static void	flush() Flushes all updated values immediately to the network.
static java.lang.Boolean[]	fromNative(boolean[] arr)
static java.lang.Double[]	fromNative(double[] arr)
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()
static NetworkTable	getTable(java.lang.String key) Gets the table with the specified key.
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.
static void	globalDeleteAll() Deletes ALL keys in ALL subtables.
static void	initialize() initializes network tables
boolean	isConnected() Get the current state of the objects connection
boolean	isPersistent(java.lang.String key) Returns whether the value is persistent through program restarts.
boolean	isServer() If the object is acting as a server
static java.lang.String[]	loadPersistent(java.lang.String filename) Loads persistent keys from a file.
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	removeConnectionListener(IRemoteConnectionListener listener) Unregister a listener from connection events
static void	removeGlobalConnectionListener(IRemoteConnectionListener listener)
void	removeTableListener(ITableListener listener) Remove a listener from receiving table events
void	retrieveValue(java.lang.String key, java.lang.Object externalData) Deprecated. Use get*Array functions instead.
static void	savePersistent(java.lang.String filename) Saves persistent keys to a file.
static void	setClientMode() set that network tables should be a client This must be called before initialize or getTable
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.
static void	setDSClientEnabled(boolean enabled)
void	setFlags(java.lang.String key, int flags) Sets flags on the specified key in this table.
static void	setIPAddress(java.lang.String address)
static void	setIPAddress(java.lang.String[] addresses)
static void	setNetworkIdentity(java.lang.String name) Sets the network identity.
void	setPersistent(java.lang.String key) Makes a key's value persistent through program restarts.
static void	setPersistentFilename(java.lang.String filename) Sets the persistent filename.
static void	setPort(int aport)
static void	setServerMode() set that network tables should be a server This must be called before initialize or getTable
static void	setTeam(int team) set the team the robot is configured for (this will set the mdns address that network tables will connect to in client mode) This must be called before initialize or getTable
static void	setUpdateRate(double interval) Set the periodic update rate.
static void	shutdown() shuts down network tables
static boolean[]	toNative(java.lang.Boolean[] arr)
static double[]	toNative(java.lang.Number[] arr)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PATH_SEPARATOR

public static final char PATH_SEPARATOR

The path separator for sub-tables and keys

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

The default port that network tables operates on

See Also:

Constant Field Values

PERSISTENT

public static final int PERSISTENT

The persistent flag value.

See Also:

Constant Field Values

Method Detail

initialize

public static void initialize()

initializes network tables

shutdown

public static void shutdown()

shuts down network tables

setServerMode

public static void setServerMode()

set that network tables should be a server This must be called before initialize or getTable

setClientMode

public static void setClientMode()

set that network tables should be a client This must be called before initialize or getTable

setTeam

public static void setTeam(int team)

set the team the robot is configured for (this will set the mdns address that network tables will connect to in client mode) This must be called before initialize or getTable

Parameters:

team - the team number

setIPAddress

public static void setIPAddress(java.lang.String address)

Parameters:

address - the adress that network tables will connect to in client mode

setIPAddress

public static void setIPAddress(java.lang.String[] addresses)

Parameters:

addresses - the adresses that network tables will connect to in client mode (in round robin order)

setPort

public static void setPort(int aport)

Parameters:

aport - the port number that network tables will connect to in client mode or listen to in server mode

setDSClientEnabled

public static void setDSClientEnabled(boolean enabled)

Parameters:

enabled - whether to enable the connection to the local DS to get the robot IP address (defaults to enabled)

setPersistentFilename

public static void setPersistentFilename(java.lang.String filename)

Sets the persistent filename.

Parameters:

filename - the filename that the network tables server uses for automatic loading and saving of persistent values

setNetworkIdentity

public static void setNetworkIdentity(java.lang.String name)

Sets the network identity. This is provided in the connection info on the remote end.

Parameters:

name - identity

toNative

public static boolean[] toNative(java.lang.Boolean[] arr)

toNative

public static double[] toNative(java.lang.Number[] arr)

fromNative

public static java.lang.Boolean[] fromNative(boolean[] arr)

fromNative

public static java.lang.Double[] fromNative(double[] arr)

getTable

public static NetworkTable getTable(java.lang.String key)

Gets the table with the specified key. If the table does not exist, a new table will be created.
This will automatically initialize network tables if it has not been already

Parameters:

key - the key name

Returns:

the network table requested

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

connections

public static ConnectionInfo[] connections()

isConnected

public boolean isConnected()

Description copied from interface: IRemote

Get the current state of the objects connection

Specified by:

isConnected in interface IRemote

Returns:

the current connection state

isServer

public boolean isServer()

Description copied from interface: IRemote

If the object is acting as a server

Specified by:

isServer in interface IRemote

Returns:

if the object is a server

addGlobalConnectionListener

public static void addGlobalConnectionListener(IRemoteConnectionListener listener,
                                               boolean immediateNotify)

removeGlobalConnectionListener

public static void removeGlobalConnectionListener(IRemoteConnectionListener listener)

addConnectionListener

public void addConnectionListener(IRemoteConnectionListener listener,
                                  boolean immediateNotify)

Description copied from interface: IRemote

Register an object to listen for connection and disconnection events

Specified by:

addConnectionListener in interface IRemote

Parameters:

listener - the listener to be register

immediateNotify - if the listener object should be notified of the current connection state

removeConnectionListener

public void removeConnectionListener(IRemoteConnectionListener listener)

Description copied from interface: IRemote

Unregister a listener from connection events

Specified by:

removeConnectionListener in interface IRemote

Parameters:

listener - the listener to be unregistered

addTableListener

public void addTableListener(ITableListener listener)

Add a listener for changes to the table

Specified by:

addTableListener in interface ITable

Parameters:

listener - the listener to add

addTableListener

public void addTableListener(ITableListener listener,
                             boolean immediateNotify)

Add a listener for changes to the table

Specified by:

addTableListener in interface ITable

Parameters:

listener - the listener to add

immediateNotify - if true then this listener will be notified of all current entries (marked as new)

addTableListenerEx

public void addTableListenerEx(ITableListener listener,
                               int flags)

Description copied from interface: ITable

Add a listener for changes to the table

Specified by:

addTableListenerEx in interface ITable

Parameters:

listener - the listener to add

flags - bitmask specifying desired notifications

addTableListener

public void addTableListener(java.lang.String key,
                             ITableListener listener,
                             boolean immediateNotify)

Add a listener for changes to a specific key the table

Specified by:

addTableListener in interface ITable

Parameters:

key - the key to listen for

listener - the listener to add

immediateNotify - if true then this listener will be notified of all current entries (marked as new)

addTableListenerEx

public void addTableListenerEx(java.lang.String key,
                               ITableListener listener,
                               int flags)

Add a listener for changes to a specific key the table

Specified by:

addTableListenerEx in interface ITable

Parameters:

key - the key to listen for

listener - the listener to add

flags - bitmask specifying desired notifications

addSubTableListener

public void addSubTableListener(ITableListener listener)

This will immediately notify the listener of all current sub tables

Specified by:

addSubTableListener in interface ITable

Parameters:

listener - the listener to notify

addSubTableListener

public void addSubTableListener(ITableListener listener,
                                boolean localNotify)

This will immediately notify the listener of all current sub tables

Specified by:

addSubTableListener in interface ITable

Parameters:

listener - the listener to notify

localNotify - if true then this listener will be notified of all local changes in addition to all remote changes

removeTableListener

public void removeTableListener(ITableListener listener)

Remove a listener from receiving table events

Specified by:

removeTableListener in interface ITable

Parameters:

listener - the listener to be removed

getSubTable

public ITable getSubTable(java.lang.String key)

Returns the table at the specified key. If there is no table at the specified key, it will create a new table

Specified by:

getSubTable in interface ITable

Parameters:

key - the name of the table relative to this one

Returns:

a sub table relative to this one

containsKey

public boolean containsKey(java.lang.String key)

Checks the table and tells if it contains the specified key

Specified by:

containsKey in interface ITable

Parameters:

key - the key to search for

Returns:

true if the table as a value assigned to the given key

containsSubTable

public boolean containsSubTable(java.lang.String key)

Specified by:

containsSubTable in interface ITable

Parameters:

key - the key to search for

Returns:

true if there is a subtable with the key which contains at least one key/subtable of its own

getKeys

public java.util.Set<java.lang.String> getKeys(int types)

Specified by:

getKeys in interface ITable

Parameters:

types - bitmask of types; 0 is treated as a "don't care".

Returns:

keys currently in the table

getKeys

public java.util.Set<java.lang.String> getKeys()

Specified by:

getKeys in interface ITable

Returns:

keys currently in the table

getSubTables

public java.util.Set<java.lang.String> getSubTables()

Specified by:

getSubTables in interface ITable

Returns:

subtables currently in the table

putNumber

public boolean putNumber(java.lang.String key,
                         double value)

Put a number in the table

Specified by:

putNumber in interface ITable

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

setDefaultNumber

public boolean setDefaultNumber(java.lang.String key,
                                double defaultValue)

Gets the current value in the table, setting it if it does not exist.

Specified by:

setDefaultNumber in interface ITable

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

getNumber

@Deprecated
public double getNumber(java.lang.String key)
                              throws TableKeyNotDefinedException

Deprecated. This exception-raising method has been replaced by the default-taking method getNumber(String, double).

Returns the number the key maps to.

Specified by:

getNumber in interface ITable

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getNumber

public double getNumber(java.lang.String key,
                        double defaultValue)

Returns the number the key maps to. If the key does not exist or is of different type, it will return the default value.

Specified by:

getNumber in interface ITable

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putString

public boolean putString(java.lang.String key,
                         java.lang.String value)

Put a string in the table

Specified by:

putString in interface ITable

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

setDefaultString

public boolean setDefaultString(java.lang.String key,
                                java.lang.String defaultValue)

Gets the current value in the table, setting it if it does not exist.

Specified by:

setDefaultString in interface ITable

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

getString

@Deprecated
public java.lang.String getString(java.lang.String key)
                                        throws TableKeyNotDefinedException

Deprecated. This exception-raising method has been replaced by the default-taking method getString(String, String).

Returns the string the key maps to.

Specified by:

getString in interface ITable

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)

Returns the string the key maps to. If the key does not exist or is of different type, it will return the default value.

Specified by:

getString in interface ITable

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putBoolean

public boolean putBoolean(java.lang.String key,
                          boolean value)

Put a boolean in the table

Specified by:

putBoolean in interface ITable

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

setDefaultBoolean

public boolean setDefaultBoolean(java.lang.String key,
                                 boolean defaultValue)

Gets the current value in the table, setting it if it does not exist.

Specified by:

setDefaultBoolean in interface ITable

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

getBoolean

@Deprecated
public boolean getBoolean(java.lang.String key)
                                throws TableKeyNotDefinedException

Deprecated. This exception-raising method has been replaced by the default-taking method getBoolean(String, boolean).

Returns the boolean the key maps to.

Specified by:

getBoolean in interface ITable

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)

Returns the boolean the key maps to. If the key does not exist or is of different type, it will return the default value.

Specified by:

getBoolean in interface ITable

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putBooleanArray

public boolean putBooleanArray(java.lang.String key,
                               boolean[] value)

Put a boolean array in the table

Specified by:

putBooleanArray in interface ITable

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

putBooleanArray

public boolean putBooleanArray(java.lang.String key,
                               java.lang.Boolean[] value)

Put a boolean array in the table

Specified by:

putBooleanArray in interface ITable

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

setDefaultBooleanArray

public boolean setDefaultBooleanArray(java.lang.String key,
                                      boolean[] defaultValue)

Gets the current value in the table, setting it if it does not exist.

Specified by:

setDefaultBooleanArray in interface ITable

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

setDefaultBooleanArray

public boolean setDefaultBooleanArray(java.lang.String key,
                                      java.lang.Boolean[] defaultValue)

Gets the current value in the table, setting it if it does not exist.

Specified by:

setDefaultBooleanArray in interface ITable

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

getBooleanArray

@Deprecated
public boolean[] getBooleanArray(java.lang.String key)
                                       throws TableKeyNotDefinedException

Deprecated. This exception-raising method has been replaced by the default-taking method getBooleanArray(String, boolean[]).

Returns the boolean array the key maps to.

Specified by:

getBooleanArray in interface ITable

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getBooleanArray

public boolean[] getBooleanArray(java.lang.String key,
                                 boolean[] defaultValue)

Returns the boolean array the key maps to. If the key does not exist or is of different type, it will return the default value.

Specified by:

getBooleanArray in interface ITable

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

getBooleanArray

public java.lang.Boolean[] getBooleanArray(java.lang.String key,
                                           java.lang.Boolean[] defaultValue)

Returns the boolean array the key maps to. If the key does not exist or is of different type, it will return the default value.

Specified by:

getBooleanArray in interface ITable

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putNumberArray

public boolean putNumberArray(java.lang.String key,
                              double[] value)

Put a number array in the table

Specified by:

putNumberArray in interface ITable

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

putNumberArray

public boolean putNumberArray(java.lang.String key,
                              java.lang.Double[] value)

Put a number array in the table

Specified by:

putNumberArray in interface ITable

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

setDefaultNumberArray

public boolean setDefaultNumberArray(java.lang.String key,
                                     double[] defaultValue)

Gets the current value in the table, setting it if it does not exist.

Specified by:

setDefaultNumberArray in interface ITable

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

setDefaultNumberArray

public boolean setDefaultNumberArray(java.lang.String key,
                                     java.lang.Double[] defaultValue)

Gets the current value in the table, setting it if it does not exist.

Specified by:

setDefaultNumberArray in interface ITable

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

getNumberArray

@Deprecated
public double[] getNumberArray(java.lang.String key)
                                     throws TableKeyNotDefinedException

Deprecated. This exception-raising method has been replaced by the default-taking method getNumberArray(String, double[]).

Returns the number array the key maps to.

Specified by:

getNumberArray in interface ITable

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getNumberArray

public double[] getNumberArray(java.lang.String key,
                               double[] defaultValue)

Returns the number array the key maps to. If the key does not exist or is of different type, it will return the default value.

Specified by:

getNumberArray in interface ITable

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

getNumberArray

public java.lang.Double[] getNumberArray(java.lang.String key,
                                         java.lang.Double[] defaultValue)

Returns the number array the key maps to. If the key does not exist or is of different type, it will return the default value.

Specified by:

getNumberArray in interface ITable

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putStringArray

public boolean putStringArray(java.lang.String key,
                              java.lang.String[] value)

Put a string array in the table

Specified by:

putStringArray in interface ITable

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

setDefaultStringArray

public boolean setDefaultStringArray(java.lang.String key,
                                     java.lang.String[] defaultValue)

Gets the current value in the table, setting it if it does not exist.

Specified by:

setDefaultStringArray in interface ITable

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

getStringArray

@Deprecated
public java.lang.String[] getStringArray(java.lang.String key)
                                               throws TableKeyNotDefinedException

Deprecated. This exception-raising method has been replaced by the default-taking method getStringArray(String, String[]).

Returns the string array the key maps to.

Specified by:

getStringArray in interface ITable

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getStringArray

public java.lang.String[] getStringArray(java.lang.String key,
                                         java.lang.String[] defaultValue)

Returns the string array the key maps to. If the key does not exist or is of different type, it will return the default value.

Specified by:

getStringArray in interface ITable

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putRaw

public boolean putRaw(java.lang.String key,
                      byte[] value)

Put a raw value (byte array) in the table

Specified by:

putRaw in interface ITable

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

setDefaultRaw

public boolean setDefaultRaw(java.lang.String key,
                             byte[] defaultValue)

Gets the current value in the table, setting it if it does not exist.

Specified by:

setDefaultRaw in interface ITable

Parameters:

key - the key

defaultValue - the default value to set if key doens't exist.

Returns:

False if the table key exists with a different type

putRaw

public boolean putRaw(java.lang.String key,
                      java.nio.ByteBuffer value,
                      int len)

Put a raw value (bytes from a byte buffer) in the table

Specified by:

putRaw in interface ITable

Parameters:

key - the key to be assigned to

value - the value that will be assigned

len - the length of the value

Returns:

False if the table key already exists with a different type

getRaw

@Deprecated
public byte[] getRaw(java.lang.String key)
                           throws TableKeyNotDefinedException

Deprecated. This exception-raising method has been replaced by the default-taking method getRaw(String, byte[]).

Returns the raw value (byte array) the key maps to.

Specified by:

getRaw in interface ITable

Parameters:

key - the key to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getRaw

public byte[] getRaw(java.lang.String key,
                     byte[] defaultValue)

Returns the raw value (byte array) the key maps to. If the key does not exist or is of different type, it will return the default value.

Specified by:

getRaw in interface ITable

Parameters:

key - the key to look up

defaultValue - the value to be returned if no value is found

Returns:

the value associated with the given key or the given default value if there is no value associated with the key

putValue

public boolean putValue(java.lang.String key,
                        java.lang.Object value)
                 throws java.lang.IllegalArgumentException

Put a value in the table

Specified by:

putValue in interface ITable

Parameters:

key - the key to be assigned to

value - the value that will be assigned

Returns:

False if the table key already exists with a different type

Throws:

java.lang.IllegalArgumentException - when the value is not supported by the table

retrieveValue

@Deprecated
public void retrieveValue(java.lang.String key,
                                       java.lang.Object externalData)
                                throws TableKeyNotDefinedException

Deprecated. Use get*Array functions instead.

Retrieve an array data type from the table.

Specified by:

retrieveValue in interface ITable

Parameters:

key - the key to be assigned to

externalData - the array data type to retreive into

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getValue

@Deprecated
public java.lang.Object getValue(java.lang.String key)
                                       throws TableKeyNotDefinedException

Deprecated. This exception-raising method has been replaced by the default-taking method getValue(String, Object).

Gets the value associated with a key as an object. If the key does not exist, it will return the default value NOTE: If the value is a double, it will return a Double object, not a primitive. To get the primitive, use ITable.getDouble(String, double).

Specified by:

getValue in interface ITable

Parameters:

key - the key of the value to look up

Returns:

the value associated with the given key

Throws:

TableKeyNotDefinedException - if there is no value associated with the given key

getValue

public java.lang.Object getValue(java.lang.String key,
                                 java.lang.Object defaultValue)

Gets the value associated with a key as an object. NOTE: If the value is a double, it will return a Double object, not a primitive. To get the primitive, use ITable.getDouble(String, double).

Specified by:

getValue in interface ITable

Parameters:

key - the key of the value to look up

defaultValue - the default value if the key is null

Returns:

the value associated with the given key

setPersistent

public void setPersistent(java.lang.String key)

Makes a key's value persistent through program restarts. The key cannot be null.

Specified by:

setPersistent in interface ITable

Parameters:

key - the key name

clearPersistent

public void clearPersistent(java.lang.String key)

Stop making a key's value persistent through program restarts. The key cannot be null.

Specified by:

clearPersistent in interface ITable

Parameters:

key - the key name

isPersistent

public boolean isPersistent(java.lang.String key)

Returns whether the value is persistent through program restarts. The key cannot be null.

Specified by:

isPersistent in interface ITable

Parameters:

key - the key name

Returns:

True if the value is persistent.

setFlags

public void setFlags(java.lang.String key,
                     int flags)

Sets flags on the specified key in this table. The key can not be null.

Specified by:

setFlags in interface ITable

Parameters:

key - the key name

flags - the flags to set (bitmask)

clearFlags

public void clearFlags(java.lang.String key,
                       int flags)

Clears flags on the specified key in this table. The key can not be null.

Specified by:

clearFlags in interface ITable

Parameters:

key - the key name

flags - the flags to clear (bitmask)

getFlags

public int getFlags(java.lang.String key)

Returns the flags for the specified key.

Specified by:

getFlags in interface ITable

Parameters:

key - the key name

Returns:

the flags, or 0 if the key is not defined

delete

public void delete(java.lang.String key)

Deletes the specified key in this table. The key can not be null.

Specified by:

delete in interface ITable

Parameters:

key - the key name

globalDeleteAll

public static void globalDeleteAll()

Deletes ALL keys in ALL subtables. Use with caution!

flush

public static void flush()

Flushes all updated values immediately to the network. Note: This is rate-limited to protect the network from flooding. This is primarily useful for synchronizing network updates with user code.

setUpdateRate

public static void setUpdateRate(double interval)

Set the periodic update rate.

Parameters:

interval - update interval in seconds (range 0.01 to 1.0)

savePersistent

public static void savePersistent(java.lang.String filename)
                           throws PersistentException

Saves persistent keys to a file. The server does this automatically.

Parameters:

filename - file name

Throws:

PersistentException - if error saving file

loadPersistent

public static java.lang.String[] loadPersistent(java.lang.String filename)
                                         throws PersistentException

Loads persistent keys from a file. The server does this automatically.

Parameters:

filename - file name

Returns:

List of warnings (errors result in an exception instead)

Throws:

PersistentException - if error reading file

putInt

@Deprecated
public boolean putInt(java.lang.String key,
                                   int value)

Deprecated. Use putNumber(String, double) instead.

Maps the specified key to the specified value in this table. The key can not be null. The value can be retrieved by calling the get method with a key that is equal to the original key.

Specified by:

putInt in interface ITable

Parameters:

key - the key

value - the value

Returns:

False if the table key already exists with a different type

getInt

@Deprecated
public int getInt(java.lang.String key)
                        throws TableKeyNotDefinedException

Deprecated. Use getNumber(String, double) instead.

Returns the value at the specified key.

Specified by:

getInt in interface ITable

Parameters:

key - the key

Returns:

the value

Throws:

TableKeyNotDefinedException - if there is no value mapped to by the key

getInt

@Deprecated
public int getInt(java.lang.String key,
                               int defaultValue)
                        throws TableKeyNotDefinedException

Deprecated. Use getNumber(String, double) instead.

Returns the value at the specified key.

Specified by:

getInt in interface ITable

Parameters:

key - the key

defaultValue - the value returned if the key is undefined

Returns:

the value

Throws:

TableKeyNotDefinedException

putDouble

@Deprecated
public boolean putDouble(java.lang.String key,
                                      double value)

Deprecated. Use putNumber(String, double) instead.

Maps the specified key to the specified value in this table. The key can not be null. The value can be retrieved by calling the get method with a key that is equal to the original key.

Specified by:

putDouble in interface ITable

Parameters:

key - the key

value - the value

Returns:

False if the table key already exists with a different type

getDouble

@Deprecated
public double getDouble(java.lang.String key)
                              throws TableKeyNotDefinedException

Deprecated. Use getNumber(String, double) instead.

Returns the value at the specified key.

Specified by:

getDouble in interface ITable

Parameters:

key - the key

Returns:

the value

Throws:

TableKeyNotDefinedException - if there is no value mapped to by the key

getDouble

@Deprecated
public double getDouble(java.lang.String key,
                                     double defaultValue)

Deprecated. Use getNumber(String, double) instead.

Returns the value at the specified key.

Specified by:

getDouble in interface ITable

Parameters:

key - the key

defaultValue - the value returned if the key is undefined

Returns:

the value