com.hp.of.lib.dt

Class QueueId

java.lang.Object

com.hp.util.cache.CacheableDataType

com.hp.util.ip.UnsignedId

com.hp.util.ip.UnsignedLongBasedId

com.hp.util.ip.U32Id

com.hp.of.lib.dt.QueueId

All Implemented Interfaces:

Serializable, Comparable<QueueId>

public final class QueueId
extends U32Id
implements Comparable<QueueId>

Represents a queue identifier (unsigned 32-bit).

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

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

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

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

Author:

Simon Hunt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static QueueId	ALL Wildcard queue used for queue stats requests; Since 1.0.

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

E_BYTES_BAD_LEN, LENGTH_IN_BYTES, MAX_VALUE

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

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(QueueId o) Implements the Comparable interface, to return queue IDs in natural order.
static QueueId	qid(String s) Convenience method that returns the queue ID instance for the given string.
String	toString() Returns a string representation of the queue ID.
static QueueId	valueOf(byte[] bytes) Returns an object that represents the queue ID defined by the specified byte array.
static QueueId	valueOf(long qid) Returns an object that represents the queue ID defined by the specified long.
static QueueId	valueOf(String s) Returns an object that represents the queue ID defined by the specified string.

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

rangeCheck, toByteArray

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

equals, hashCode, toLong

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

ALL

public static final QueueId ALL

Wildcard queue used for queue stats requests; Since 1.0.

Method Detail

toString

public String toString()

Returns a string representation of the queue ID. Reserved values will include the logical name of the queue.

Overrides:

toString in class UnsignedLongBasedId

Returns:

a string representation of the queue ID

compareTo

public int compareTo(QueueId o)

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

Specified by:

compareTo in interface Comparable<QueueId>

Parameters:

o - the other queue ID

Returns:

an integer value indicating relative ordering

See Also:

Comparable.compareTo(T)

valueOf

public static QueueId valueOf(long qid)

Returns an object that represents the queue ID defined by the specified long.

Parameters:

qid - the queue ID

Returns:

the corresponding queue ID instance

Throws:

IllegalArgumentException - if the queue ID is not u32

valueOf

public static QueueId valueOf(String s)

Returns an object that represents the queue 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 queue ID as a string

Returns:

the corresponding queue ID instance

Throws:

IllegalArgumentException - if the string is invalid

NullPointerException - if the string is null

qid

public static QueueId qid(String s)

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

 QueueId q = QueueId.valueOf("4");
 QueueId q = qid("4");
 

Parameters:

s - the queue ID as a string

Returns:

the corresponding queue ID instance

Throws:

IllegalArgumentException - if the string is invalid

NullPointerException - if the string is null

valueOf

public static QueueId valueOf(byte[] bytes)

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

Parameters:

bytes - the encoded ID

Returns:

the corresponding queue ID instance

Throws:

NullPointerException - if the byte array is null

IllegalArgumentException - if the byte array is not 4 bytes long