com.hp.of.lib.dt

Class GroupId

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

All Implemented Interfaces:

Serializable, Comparable<GroupId>

public final class GroupId
extends U32Id
implements Comparable<GroupId>

Represents a group identifier (unsigned 32-bit).

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

Author:

Simon Hunt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static GroupId	ALL All groups, for group delete commands or group stats requests; Since 1.1.
static GroupId	ANY Wildcard group used for flow stats requests; Since 1.1.
static GroupId	MAX Last usable group number; Since 1.1.

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

Last usable group number; Since 1.1.

ALL

public static final GroupId ALL

All groups, for group delete commands or group stats requests; Since 1.1.

ANY

public static final GroupId ANY

Wildcard group used for flow stats requests; Since 1.1. Selects all flows regardless of output group (including flows with no output group).

Method Detail

toString

public String toString()

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

Overrides:

toString in class UnsignedLongBasedId

Returns:

a string representation of the group ID

compareTo

public int compareTo(GroupId o)

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

Specified by:

compareTo in interface Comparable<GroupId>

Parameters:

o - the other group ID

Returns:

an integer value indicating relative ordering

See Also:

Comparable.compareTo(T)

valueOf

public static GroupId valueOf(long gid)

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

Parameters:

gid - the group ID expressed as a long

Returns:

the corresponding group ID instance

Throws:

IllegalArgumentException - if the group ID is not u32

valueOf

public static GroupId valueOf(String s)

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

Returns:

the corresponding group ID instance

Throws:

IllegalArgumentException - if the string is invalid

NullPointerException - if the string is null

gid

public static GroupId gid(String s)

Convenience method that returns the group ID instance for the given string representation. 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:

 GroupId g = GroupId.valueOf("3");
 GroupId g = gid("3");
 

Parameters:

s - the group ID as a string

Returns:

the corresponding group ID instance

Throws:

IllegalArgumentException - if the string is invalid

NullPointerException - if the string is null

valueOf

public static GroupId valueOf(byte[] bytes)

Returns an object that represents the group 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:

a GroupId instance

Throws:

NullPointerException - if the byte array is null

IllegalArgumentException - if the byte array is not 4 bytes long