io.github.robolib.nettable

Class NetworkTable

java.lang.Object

io.github.robolib.nettable.NetworkTable

All Implemented Interfaces:

ITable

public class NetworkTable
extends java.lang.Object
implements ITable

NetworkTables 2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	NetworkTable.EntryCache
(package private) static class	NetworkTable.NetworkTableKeyCache

Field Summary

Fields

Modifier and Type	Field and Description
private NetworkTable.NetworkTableKeyCache	m_absoluteKeyCache
private NetworkTable.EntryCache	m_entryCache
private java.util.Hashtable<ITableListener,java.util.List<ITableListener>>	m_listenerMap
private java.lang.String	m_path
private static NTServerTableProvider	m_provider
private static NTServer	m_server
static char	PATH_SEPARATOR The path separator for sub-tables and keys

Constructor Summary

Constructors

Constructor and Description
NetworkTable(java.lang.String path)

Method Summary

Modifier and Type	Method and Description
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
private static void	checkInit()
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.
private NTTableEntry	getEntry(java.lang.String 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 ITable	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()
boolean	isServer()
void	putBoolean(java.lang.String key, boolean value) Maps the specified key to the specified value in this table.
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	removeTableListener(ITableListener listener) Remove a listener from receiving table events
void	retrieveValue(java.lang.String key, java.lang.Object externalValue)
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

m_provider

private static NTServerTableProvider m_provider

m_server

private static NTServer m_server

m_path

private final java.lang.String m_path

m_entryCache

private final NetworkTable.EntryCache m_entryCache

m_absoluteKeyCache

private final NetworkTable.NetworkTableKeyCache m_absoluteKeyCache

m_listenerMap

private final java.util.Hashtable<ITableListener,java.util.List<ITableListener>> m_listenerMap

Constructor Detail

NetworkTable

NetworkTable(java.lang.String path)

Method Detail

checkInit

private static void checkInit()

initialize

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

Throws:

java.io.IOException

getTable

public static ITable 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()

isServer

public boolean isServer()

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

getEntry

private NTTableEntry getEntry(java.lang.String key)

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 java.util.NoSuchElementException

Returns the key that the name maps to.

Specified by:

getNumber in interface ITable

Parameters:

key - the key name

Returns:

the key

Throws:

java.util.NoSuchElementException - 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 java.util.NoSuchElementException

Returns the key that the name maps to.

Specified by:

getString in interface ITable

Parameters:

key - the key name

Returns:

the key

Throws:

java.util.NoSuchElementException - 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 java.util.NoSuchElementException

Returns the key that the name maps to.

Specified by:

getBoolean in interface ITable

Parameters:

key - the key name

Returns:

the key

Throws:

java.util.NoSuchElementException - 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 java.util.NoSuchElementException

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:

java.util.NoSuchElementException - 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