com.hp.util.ip

Class Vni

java.lang.Object

com.hp.util.ip.Vni

All Implemented Interfaces:

Comparable<Vni>

public class Vni
extends Object
implements Comparable<Vni>

Represents a Virtual Network Identifier, which is an unsigned, 24-bit value.

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

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

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

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

Author:

Simon Hunt, Jesse Hummer, Scott Simes

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_VALUE The maximum permissible value (16777215).
static int	MIN_VALUE The minimum permissible value (0).

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Vni o)
boolean	equals(Object o)
int	hashCode()
int	toInt() Returns the Virtual Network Identifier represented as an integer.
String	toString() Returns a string representation of this Virtual Network Identifier, as a decimal number.
static Vni	valueOf(int value) Returns a Virtual Network Identifier instance representing the value given by the specified integer.
static Vni	valueOf(String value) Returns a Virtual Network Identifier instance representing the value given by the specified string.
static Vni	vni(int value) A convenience method that simply delegates to valueOf(int).

Methods inherited from class java.lang.Object

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

Field Detail

MAX_VALUE

public static final int MAX_VALUE

The maximum permissible value (16777215).

See Also:

Constant Field Values

MIN_VALUE

public static final int MIN_VALUE

The minimum permissible value (0).

See Also:

Constant Field Values

Method Detail

toString

public String toString()

Returns a string representation of this Virtual Network Identifier, as a decimal number.

Overrides:

toString in class Object

Returns:

the VNI as a string

toInt

public int toInt()

Returns the Virtual Network Identifier represented as an integer.

Returns:

the VNI encoded as an int

valueOf

public static Vni valueOf(int value)

Returns a Virtual Network Identifier instance representing the value given by the specified integer.

Parameters:

value - the value

Returns:

the Virtual Network Identifier for the given value

Throws:

IllegalArgumentException - if value is not u24

vni

public static Vni vni(int value)

A convenience method that simply delegates to valueOf(int).

Included so that this method may be statically imported, such that it is easy to express VNIs in code:

     import static com.hp.util.ip.Vni.vni;
     ...
     Vni v = vni(3);
 

Parameters:

value - the value

Returns:

the Virtual Network Identifier for the given value

Throws:

IllegalArgumentException - if value is not u24

valueOf

public static Vni valueOf(String value)

Returns a Virtual Network Identifier instance representing the value given by the specified string. Recognized formats are decimal or hex (prefixed with "0x") strings.

The following examples return a VNI of 23:

     Vni v1 = Vni.valueOf("23");
     Vni v2 = Vni.valueOf("0x17");
 

Parameters:

value - a string representing a number

Returns:

the Virtual Network Identifier for the given value

Throws:

NullPointerException - if value is null

IllegalArgumentException - if value is not parsable as a u24 value

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Vni o)

Specified by:

compareTo in interface Comparable<Vni>