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

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

Method Summary

Modifier and Type	Method and Description
void	addConnectionListener(IRemoteConnectionListener listener, boolean immediateNotify) Register an object to listen for connection and disconnection events
void	addSubTableListener(ITableListener listener) 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
boolean	containsKey(java.lang.String key) Checks the table and tells if it contains the specified key
boolean	containsSubTable(java.lang.String key)
boolean	getBoolean(java.lang.String key) Returns the key that the name maps to.
boolean	getBoolean(java.lang.String key, boolean defaultValue) Returns the key that the name maps to.
double	getDouble(java.lang.String key) Deprecated. Returns the value at the specified key.
double	getDouble(java.lang.String key, double defaultValue) Deprecated. Returns the value at the specified key.
int	getInt(java.lang.String key) Deprecated. Returns the value at the specified key.
int	getInt(java.lang.String key, int defaultValue) Deprecated. Returns the value at the specified key.
double	getNumber(java.lang.String key) Returns the key that the name maps to.
double	getNumber(java.lang.String key, double defaultValue) Returns the key that the name maps to.
java.lang.String	getString(java.lang.String key) Returns the key that the name maps to.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Returns the key that the name maps to.
ITable	getSubTable(java.lang.String key) Returns the table at the specified key.
static NetworkTable	getTable(java.lang.String key) Gets the table with the specified key.
java.lang.Object	getValue(java.lang.String key) Returns the key that the name maps to.
java.lang.Object	getValue(java.lang.String key, java.lang.Object defaultValue) Returns the key that the name maps to.
static void	initialize()
boolean	isConnected() Get the current state of the objects connection
boolean	isServer() If the object is acting as a server
void	putBoolean(java.lang.String key, boolean value) Maps the specified key to the specified value in this table.
void	putDouble(java.lang.String key, double value) Deprecated. 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.
void	putInt(java.lang.String key, int value) Deprecated. 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.
void	putNumber(java.lang.String key, double value) Maps the specified key to the specified value in this table.
void	putString(java.lang.String key, java.lang.String value) Maps the specified key to the specified value in this table.
void	putValue(java.lang.String key, java.lang.Object value) Maps the specified key to the specified value in this table.
void	removeConnectionListener(IRemoteConnectionListener listener) Unregister a listener from connection events
void	removeTableListener(ITableListener listener) Remove a listener from receiving table events
void	retrieveValue(java.lang.String key, java.lang.Object externalValue)
static void	setClientMode() set that network tables should be a client This must be called before initalize or getTable
static void	setIPAddress(java.lang.String address)
static void	setServerMode() set that network tables should be a server This must be called before initalize or getTable
static void	setTableProvider(NetworkTableProvider provider) set the table provider for static network tables methods This must be called before initalize or getTable
static void	setTeam(int team) set the team the robot is configured for (this will set the ip address that network tables will connect to in client mode) This must be called before initalize or getTable
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

Method Detail

initialize

public static void initialize()
                       throws java.io.IOException

Throws:

java.io.IOException

setTableProvider

public static void setTableProvider(NetworkTableProvider provider)

set the table provider for static network tables methods This must be called before initalize or getTable

setServerMode

public static void setServerMode()

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

setClientMode

public static void setClientMode()

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

setTeam

public static void setTeam(int team)

set the team the robot is configured for (this will set the ip address that network tables will connect to in client mode) This must be called before initalize 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

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

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

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)

Description copied from interface: ITable

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)

Description copied from interface: ITable

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)

addTableListener

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

Description copied from interface: ITable

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)

addSubTableListener

public void addSubTableListener(ITableListener listener)

Description copied from interface: ITable

This will immediately notify the listener of all current sub tables

Specified by:

addSubTableListener in interface ITable

removeTableListener

public void removeTableListener(ITableListener listener)

Description copied from interface: ITable

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 key name

Returns:

the networktable to be returned

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 be checked

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

putNumber

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

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:

putNumber in interface ITable

Parameters:

key - the key

value - the value

getNumber

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

Returns the key that the name maps to.

Specified by:

getNumber in interface ITable

Parameters:

key - the key name

Returns:

the key

Throws:

TableKeyNotDefinedException - if the specified key is null

getNumber

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

Returns the key that the name maps to. If the key is null, it will return the default value

Specified by:

getNumber in interface ITable

Parameters:

key - the key name

defaultValue - the default value if the key is null

Returns:

the key

putString

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

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:

putString in interface ITable

Parameters:

key - the key

value - the value

getString

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

Returns the key that the name maps to.

Specified by:

getString in interface ITable

Parameters:

key - the key name

Returns:

the key

Throws:

TableKeyNotDefinedException - if the specified key is null

getString

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

Returns the key that the name maps to. If the key is null, it will return the default value

Specified by:

getString in interface ITable

Parameters:

key - the key name

defaultValue - the default value if the key is null

Returns:

the key

putBoolean

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

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:

putBoolean in interface ITable

Parameters:

key - the key

value - the value

getBoolean

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

Returns the key that the name maps to.

Specified by:

getBoolean in interface ITable

Parameters:

key - the key name

Returns:

the key

Throws:

TableKeyNotDefinedException - if the specified key is null

getBoolean

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

Returns the key that the name maps to. If the key is null, it will return the default value

Specified by:

getBoolean in interface ITable

Parameters:

key - the key name

defaultValue - the default value if the key is null

Returns:

the key

retrieveValue

public void retrieveValue(java.lang.String key,
                          java.lang.Object externalValue)

Specified by:

retrieveValue in interface ITable

putValue

public void putValue(java.lang.String key,
                     java.lang.Object value)

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:

putValue in interface ITable

Parameters:

key - the key name

value - the value to be put

getValue

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

Returns the key that the name maps to. NOTE: If the value is a double, it will return a Double object, not a primitive. To get the primitive, use getDouble

Specified by:

getValue in interface ITable

Parameters:

key - the key name

Returns:

the key

Throws:

TableKeyNotDefinedException - if the specified key is null

getValue

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

Returns the key that the name maps to. If the key is null, 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 getDouble

Parameters:

key - the key name

defaultValue - the default value if the key is null

Returns:

the key

putInt

public void putInt(java.lang.String key,
                   int value)

Deprecated. 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

Throws:

java.lang.IllegalArgumentException - if key is null

getInt

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

Deprecated. 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

java.lang.IllegalArgumentException - if the value mapped to by the key is not an int

java.lang.IllegalArgumentException - if the key is null

getInt

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

Deprecated. 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:

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

java.lang.IllegalArgumentException - if the value mapped to by the key is not an int

java.lang.IllegalArgumentException - if the key is null

TableKeyNotDefinedException

putDouble

public void putDouble(java.lang.String key,
                      double value)

Deprecated. 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

Throws:

java.lang.IllegalArgumentException - if key is null

getDouble

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

Deprecated. Returns the value at the specified key.

Specified by:

getDouble in interface ITable

Parameters:

key - the key

Returns:

the value

Throws:

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

java.lang.IllegalArgumentException - if the value mapped to by the key is not a double

java.lang.IllegalArgumentException - if the key is null

TableKeyNotDefinedException

getDouble

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

Deprecated. 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

Throws:

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

java.lang.IllegalArgumentException - if the value mapped to by the key is not a double

java.lang.IllegalArgumentException - if the key is null