com.hp.of.lib.dt

Class MeterId

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.MeterId

All Implemented Interfaces:

Serializable, Comparable<MeterId>

public final class MeterId
extends U32Id
implements Comparable<MeterId>

Represents a meter identifier (unsigned 32-bit); Since 1.3.

All constructors for this class are private. Creating instances of MeterId 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 meter IDs is presented in an intuitive order.

Author:

Simon Hunt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static MeterId	ALL Represents all meters for stat requests commands.
static MeterId	CONTROLLER Meter for controller connection.
static MeterId	MAX Meters are designated by a number from 1 to MAX (0xffff0000).
static MeterId	SLOWPATH Meter for slow datapath, if any.

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

MAX

public static final MeterId MAX

Meters are designated by a number from 1 to MAX (0xffff0000).

SLOWPATH

public static final MeterId SLOWPATH

Meter for slow datapath, if any.

CONTROLLER

public static final MeterId CONTROLLER

Meter for controller connection.

ALL

public static final MeterId ALL

Represents all meters for stat requests commands.

Method Detail

toString

public String toString()

Description copied from class: UnsignedLongBasedId

Returns a string representation of this id. This default implementation expresses the value as a hex number, beginning with "0x...".

Overrides:

toString in class UnsignedLongBasedId

Returns:

the id, as a string

compareTo

public int compareTo(MeterId o)

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

Specified by:

compareTo in interface Comparable<MeterId>

Parameters:

o - the other meter ID

Returns:

an integer value indicating relative ordering

See Also:

Comparable.compareTo(T)

valueOf

public static MeterId valueOf(long mid)

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

Parameters:

mid - the meter ID

Returns:

the corresponding meter ID instance

Throws:

IllegalArgumentException - if the meter ID is not u32

valueOf

public static MeterId valueOf(String s)

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

Returns:

the corresponding meter ID instance

Throws:

IllegalArgumentException - if the string is invalid

NullPointerException - if the string is null

mid

public static MeterId mid(String s)

Convenience method that returns the meter ID defined by the specified 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:

 MeterId m = MeterId.valueOf("35");
 MeterId m = mid("35");
 

Parameters:

s - the meter ID as a string

Returns:

the corresponding meter ID instance

Throws:

IllegalArgumentException - if the string is invalid

NullPointerException - if the string is null

valueOf

public static MeterId valueOf(byte[] bytes)

Returns an object that represents the meter identifier 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 meter ID instance

Throws:

NullPointerException - if the byte array is null

IllegalArgumentException - if the byte array is not 4 bytes long