com.hp.of.lib.dt

Class VId

java.lang.Object

com.hp.util.cache.CacheableDataType

com.hp.util.ip.UnsignedId

com.hp.util.ip.UnsignedIntBasedId

com.hp.util.ip.U16Id

com.hp.of.lib.dt.VId

All Implemented Interfaces:

Serializable, Comparable<VId>

public final class VId
extends U16Id
implements Comparable<VId>

Represents a virtual identifier (unsigned 16-bit).

Creating instances of VId is done via the static methods of the class, or by using the predefined constants NONE or PRESENT.

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 virtual identifiers is presented in an intuitive order.

Author:

Simon Hunt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static VId	NONE A special value denoting the absence of a virtual ID.
static VId	PRESENT A special value denoting the presence of a virtual ID, without defining the specific value.

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

E_BYTES_BAD_LEN, LENGTH_IN_BYTES, 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(VId o) Implements the Comparable interface, to return virtual IDs in natural order.
static String	specialName(VId v) Returns the logical name of the given virtual ID if it is a special value; null otherwise.
String	toString() Returns a string representation of this id.
static VId	valueOf(byte[] bytes) Returns an object that represents the virtual ID defined by the specified byte array.
static VId	valueOf(int vid) Returns an object that represents the virtual ID defined by the specified integer.
static VId	valueOf(String s) Returns an object that represents the virtual ID defined by the specified string.
static VId	vid(String s) Convenience method that returns the virtual ID for the given string.

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

rangeCheck, toByteArray

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

NONE

public static final VId NONE

A special value denoting the absence of a virtual ID.

PRESENT

public static final VId PRESENT

A special value denoting the presence of a virtual ID, without defining the specific value.

Method Detail

compareTo

public int compareTo(VId o)

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

Specified by:

compareTo in interface Comparable<VId>

Parameters:

o - the other ID

Returns:

an integer value indicating relative ordering

See Also:

Comparable.compareTo(T)

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

valueOf

public static VId valueOf(int vid)

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

Parameters:

vid - the virtual ID number

Returns:

the corresponding virtual ID instance

Throws:

IllegalArgumentException - if the ID number is invalid

valueOf

public static VId valueOf(String s)

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

Parameters:

s - the virtual ID number as a string

Returns:

the corresponding virtual ID instance

Throws:

IllegalArgumentException - if the string is invalid

NullPointerException - if the string is null

vid

public static VId vid(String s)

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

 VId v = VId.valueOf("8");
 VId v = vid("8");
 

Parameters:

s - the virtual ID number as a string

Returns:

the corresponding virtual ID instance

Throws:

IllegalArgumentException - if the string is invalid

NullPointerException - if the string is null

valueOf

public static VId valueOf(byte[] bytes)

Returns an object that represents the virtual ID defined by the specified byte array. The array is expected to be U16Id.LENGTH_IN_BYTES bytes long.

Parameters:

bytes - the encoded ID

Returns:

the corresponding virtual ID instance

Throws:

NullPointerException - if the byte array is null

IllegalArgumentException - if the byte array is not 2 bytes long

specialName

public static String specialName(VId v)

Returns the logical name of the given virtual ID if it is a special value; null otherwise.

Parameters:

v - the value

Returns:

its logical name