io.github.robolib.nettable.entry

Class NTTableEntry

java.lang.Object

io.github.robolib.nettable.entry.NTTableEntry

public class NTTableEntry
extends java.lang.Object

An entry in a network table

Field Summary

Fields

Modifier and Type	Field and Description
private static char	HALF_OF_CHAR
private char	m_id
private boolean	m_isDirty
private boolean	m_isNew
java.lang.String	m_name the name of the entry
private char	m_sequenceNumber
private NTEntryType	m_type the type of the entry
private java.lang.Object	m_value
static char	UNKNOWN_ID the id that represents that an id is unknown for an entry

Constructor Summary

Constructors

Constructor and Description
NTTableEntry(char id, java.lang.String name, char sequenceNumber, NTEntryType type, java.lang.Object value) Create a new entry with the given id, name, sequence number, type and value
NTTableEntry(java.lang.String name, NTEntryType type, java.lang.Object value) Create a new entry with the given name, type, value, an unknown id and a sequence number of 0

Method Summary

Modifier and Type	Method and Description
void	clearId() clear the id of the entry to unknown
void	fireListener(NTEntryStore.TableListenerManager listenerManager)
void	forcePut(char newSequenceNumber, NTEntryType type, java.lang.Object newValue) force a value and new sequence number upon an entry, Will also set the type of the entry
void	forcePut(char newSequenceNumber, java.lang.Object newValue) force a value and new sequence number upon an entry
char	getId()
char	getSequenceNumber()
NTEntryType	getType()
java.lang.Object	getValue()
boolean	isDirty()
void	makeClean()
void	makeDirty()
boolean	putValue(char newSequenceNumber, java.lang.Object newValue) set the value of the entry if the given sequence number is greater that the current sequence number
void	send(NTConnection connection)
void	sendValue(java.io.DataOutputStream os) Send the value of the entry over the output stream
void	setId(char id) Sets the id of the entry
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_ID

public static final char UNKNOWN_ID

the id that represents that an id is unknown for an entry

See Also:

Constant Field Values

m_id

private char m_id

m_sequenceNumber

private char m_sequenceNumber

m_name

public final java.lang.String m_name

the name of the entry

m_type

private NTEntryType m_type

the type of the entry

m_value

private java.lang.Object m_value

m_isNew

private volatile boolean m_isNew

m_isDirty

private volatile boolean m_isDirty

HALF_OF_CHAR

private static final char HALF_OF_CHAR

See Also:

Constant Field Values

Constructor Detail

NTTableEntry

public NTTableEntry(java.lang.String name,
                    NTEntryType type,
                    java.lang.Object value)

Create a new entry with the given name, type, value, an unknown id and a sequence number of 0

Parameters:

name -

type -

value -

NTTableEntry

public NTTableEntry(char id,
                    java.lang.String name,
                    char sequenceNumber,
                    NTEntryType type,
                    java.lang.Object value)

Create a new entry with the given id, name, sequence number, type and value

Parameters:

id -

name -

sequenceNumber -

type -

value -

Method Detail

getId

public char getId()

Returns:

the id of the entry

getValue

public java.lang.Object getValue()

Returns:

the current value of the entry

getType

public NTEntryType getType()

Returns:

the type of the entry

putValue

public boolean putValue(char newSequenceNumber,
                        java.lang.Object newValue)

set the value of the entry if the given sequence number is greater that the current sequence number

Parameters:

newSequenceNumber - the sequence number of the incoming entry

newValue - the new value

Returns:

true if the value was set

forcePut

public void forcePut(char newSequenceNumber,
                     java.lang.Object newValue)

force a value and new sequence number upon an entry

Parameters:

newSequenceNumber -

newValue -

forcePut

public void forcePut(char newSequenceNumber,
                     NTEntryType type,
                     java.lang.Object newValue)

force a value and new sequence number upon an entry, Will also set the type of the entry

Parameters:

newSequenceNumber -

type -

newValue -

makeDirty

public void makeDirty()

makeClean

public void makeClean()

isDirty

public boolean isDirty()

sendValue

public void sendValue(java.io.DataOutputStream os)
               throws java.io.IOException

Send the value of the entry over the output stream

Parameters:

os -

Throws:

java.io.IOException

getSequenceNumber

public char getSequenceNumber()

Returns:

the current sequence number of the entry

setId

public void setId(char id)
           throws java.lang.IllegalStateException

Sets the id of the entry

Parameters:

id - the id of the entry

Throws:

java.lang.IllegalStateException - if the entry already has a known id

clearId

public void clearId()

clear the id of the entry to unknown

send

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

Throws:

java.io.IOException

fireListener

public void fireListener(NTEntryStore.TableListenerManager listenerManager)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object