io.github.robolib.nettable.entry

Class NTEntryStore

java.lang.Object

io.github.robolib.nettable.entry.NTEntryStore

public class NTEntryStore
extends java.lang.Object

An entry store that handles storing entries and applying transactions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NTEntryStore.TableListenerManager An object that handles firing Table Listeners

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.Character,NTTableEntry>	m_idEntries
private NTEntryStore.TableListenerManager	m_listenerManager
private java.util.Hashtable<java.lang.String,NTTableEntry>	m_namedEntries
private char	m_nextId
private NTWriteManager	m_receiverIn
private NTWriteManager	m_receiverOut

Constructor Summary

Constructors

Constructor and Description
NTEntryStore(NTEntryStore.TableListenerManager listenerManager)

Method Summary

Modifier and Type	Method and Description
boolean	addEntry(NTTableEntry newEntry)
void	clearEntries() Remove all entries NOTE: This method should not be used with applications which cache entries which would lead to unknown results This method is for use in testing only
void	clearIds() clear the id's of all entries
NTTableEntry	getEntry(char entryId) Get an entry based on it's id
NTTableEntry	getEntry(java.lang.String name) Get an entry based on it's name
java.util.Set<java.lang.String>	keys() Get an entry based on it's name
void	notifyEntries(ITable table, ITableListener listener) Called to say that a listener should notify the listener manager of all of the entries
void	offerIncomingAssignment(NTTableEntry entry)
void	offerIncomingUpdate(NTTableEntry entry, char sequenceNumber, java.lang.Object value)
void	putOutgoing(NTTableEntry tableEntry, java.lang.Object value)
void	putOutgoing(java.lang.String name, NTEntryType type, java.lang.Object value) Stores the given value under the given name and queues it for transmission to the server.
void	sendServerHello(NTConnection connection) Send all entries in the entry store as entry assignments in a single transaction
void	setInOutReceiver(NTWriteManager receiver)
boolean	updateEntry(NTTableEntry entry, char sequenceNumber, java.lang.Object value)
private static boolean	valuesEqual(java.lang.Object o1, java.lang.Object o2) Check if two objects are equal doing a deep equals of arrays This method assumes that o1 and o2 are of the same type (if one is an object array the other one is also)

Methods inherited from class java.lang.Object

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

Field Detail

m_idEntries

private final java.util.Map<java.lang.Character,NTTableEntry> m_idEntries

m_namedEntries

private final java.util.Hashtable<java.lang.String,NTTableEntry> m_namedEntries

m_listenerManager

private final NTEntryStore.TableListenerManager m_listenerManager

m_receiverOut

private NTWriteManager m_receiverOut

m_receiverIn

private NTWriteManager m_receiverIn

m_nextId

private char m_nextId

Constructor Detail

NTEntryStore

public NTEntryStore(NTEntryStore.TableListenerManager listenerManager)

Method Detail

getEntry

public NTTableEntry getEntry(char entryId)

Get an entry based on it's id

Parameters:

entryId - the id f the entry to look for

Returns:

the entry or null if the entry does not exist

getEntry

public NTTableEntry getEntry(java.lang.String name)

Get an entry based on it's name

Parameters:

name - the name of the entry to look for

Returns:

the entry or null if the entry does not exist

keys

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

Get an entry based on it's name

Parameters:

m_name - the name of the entry to look for

Returns:

the entry or null if the entry does not exist

clearEntries

public void clearEntries()

Remove all entries NOTE: This method should not be used with applications which cache entries which would lead to unknown results This method is for use in testing only

clearIds

public void clearIds()

clear the id's of all entries

setInOutReceiver

public void setInOutReceiver(NTWriteManager receiver)

addEntry

public boolean addEntry(NTTableEntry newEntry)

updateEntry

public boolean updateEntry(NTTableEntry entry,
                           char sequenceNumber,
                           java.lang.Object value)

valuesEqual

private static boolean valuesEqual(java.lang.Object o1,
                                   java.lang.Object o2)

Check if two objects are equal doing a deep equals of arrays This method assumes that o1 and o2 are of the same type (if one is an object array the other one is also)

Parameters:

o1 -

o2 -

putOutgoing

public void putOutgoing(java.lang.String name,
                        NTEntryType type,
                        java.lang.Object value)
                 throws WrongEntryTypeException

Stores the given value under the given name and queues it for transmission to the server.

Parameters:

name - The name under which to store the given value.

type - The type of the given value.

value - The value to store.

Throws:

WrongEntryTypeException - Thrown if an entry already exists with the given name and is of a different type.

putOutgoing

public void putOutgoing(NTTableEntry tableEntry,
                        java.lang.Object value)

offerIncomingAssignment

public void offerIncomingAssignment(NTTableEntry entry)

offerIncomingUpdate

public void offerIncomingUpdate(NTTableEntry entry,
                                char sequenceNumber,
                                java.lang.Object value)

sendServerHello

public void sendServerHello(NTConnection connection)
                     throws java.io.IOException

Send all entries in the entry store as entry assignments in a single transaction

Parameters:

connection -

Throws:

java.io.IOException

notifyEntries

public void notifyEntries(ITable table,
                          ITableListener listener)

Called to say that a listener should notify the listener manager of all of the entries

Parameters:

listener -

table -