com.hp.of.lib.dt

Class TableId

java.lang.Object

com.hp.util.cache.CacheableDataType

com.hp.util.ip.UnsignedId

com.hp.util.ip.UnsignedIntBasedId

com.hp.util.ip.U8Id

com.hp.of.lib.dt.TableId

All Implemented Interfaces:

Serializable, Comparable<TableId>

public final class TableId
extends U8Id
implements Comparable<TableId>

Represents a table identifier (unsigned 8-bit); Since 1.0. Table IDs start at 0 and run through MAX.

All constructors for this class are private. Creating instances of TableId is done via the static methods on the class.

Instances of this class are immutable, making them inherently threadsafe.

This class overrides UnsignedIntBasedId.equals(java.lang.Object) and UnsignedIntBasedId.hashCode() so that instances play nicely with the Collection classes.

This class implements the Comparable interface to ensure that a sorted list of table IDs is presented in an intuitive order.

Author:

Simon Hunt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static TableId	ALL Denotes all tables.
static TableId	MAX Denotes the last usable table ID number.

Fields inherited from class com.hp.util.ip.U8Id

MAX_VALUE

Fields inherited from class com.hp.util.ip.UnsignedIntBasedId

id

Fields inherited from class com.hp.util.ip.UnsignedId

E_BAD, E_NULL_BYTES, E_NULL_STR, E_OOR, MIN_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(TableId o) Implements the Comparable interface, to return table IDs in natural order.
static TableId	tid(String s) Convenience method that returns the table ID for the given string.
String	toString() Returns a string representation of this id.
static TableId	valueOf(byte b) Returns an object that represents the table ID defined by the specified byte.
static TableId	valueOf(int tid) Returns an object that represents the table ID defined by the specified integer.
static TableId	valueOf(String s) Returns an object that represents the table ID defined by the specified string.

Methods inherited from class com.hp.util.ip.U8Id

rangeCheck, toByte

Methods inherited from class com.hp.util.ip.UnsignedIntBasedId

equals, hashCode, toInt

Methods inherited from class com.hp.util.ip.UnsignedId

parseIntStr, parseLongStr

Methods inherited from class com.hp.util.cache.CacheableDataType

getRefQ, keyFromBytes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MAX

public static final TableId MAX

Denotes the last usable table ID number. (Tables are numbered from 0 to TableId.MAX.)

ALL

public static final TableId ALL

Denotes all tables.

Method Detail

toString

public String toString()

Description copied from class: UnsignedIntBasedId

Returns a string representation of this id.

Overrides:

toString in class UnsignedIntBasedId

Returns:

the id, as a string

compareTo

public int compareTo(TableId o)

Implements the Comparable interface, to return table IDs in natural order.

Specified by:

compareTo in interface Comparable<TableId>

Parameters:

o - the other table ID

Returns:

an integer value indicating relative ordering

See Also:

Comparable.compareTo(T)

valueOf

public static TableId valueOf(int tid)

Returns an object that represents the table ID defined by the specified integer.

Parameters:

tid - the table ID

Returns:

the corresponding table ID instance

Throws:

IllegalArgumentException - if the table ID is invalid

valueOf

public static TableId valueOf(String s)

Returns an object that represents the table ID defined by the specified string. The string is parsed as a base-10 integer, unless it has a "0x" prefix, in which case it is parsed as a hex number.

Parameters:

s - the table ID as a string

Returns:

the corresponding table ID instance

Throws:

IllegalArgumentException - if the string is invalid

NullPointerException - if the string is null

tid

public static TableId tid(String s)

Convenience method that returns the table ID for the given string. This method simply delegates to valueOf(String). By using a static import of this method, code may be written more concisely. For example, the following two statements are equivalent:

 TableId t = TableId.valueOf("2");    
 TableId t = tid("2");    
 

Parameters:

s - the table ID as a string

Returns:

the corresponding table ID instance

Throws:

IllegalArgumentException - if the string is invalid

NullPointerException - if the string is null

valueOf

public static TableId valueOf(byte b)

Returns an object that represents the table ID defined by the specified byte.

Parameters:

b - the encoded ID

Returns:

the corresponding table ID instance