VniRange (sdn-apidoc 2.5.14 API)

java.lang.Object
- com.hp.util.ip.VniRange

```
public final class VniRange
extends Object
```
Represents a range of Virtual Network Identifiers. Instances of this class are created using the valueOf(java.lang.String) factory method.
A string specification is used to define the VNI range, using the form:
```
     {first}-{last}
 
```
where first and last are values accepted by the Vni.valueOf(String) method.
For example, the specification "15-30" declares that the range of VNIs starts with 15 and ends with 30.
Author:

Simon Hunt

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class AbstractRange.RangeIterator<V extends Comparable<V>>
A partial implementation of a range iterator.

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AbstractRange.RangeIterator<V extends Comparable<V>>` A partial implementation of a range iterator.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`E_BAD_SPEC` Exception message prefix for bad specification string.
`protected T`	`first`
`protected static int`	`FIRST` Index for first item returned by `splitSpec(String)`.
`protected static String`	`HYPHEN` The hyphen character, "-".
`protected T`	`last`
`protected static int`	`LAST` Index for last item returned by `splitSpec(String)`.
`protected static Random`	`RANDOM` Random number generator.
`protected int`	`size`
`protected String`	`spec`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`contains(com.hp.util.ip.AbstractRange<T> other)` Returns `true` if this range is a superset of the other range; false otherwise.
`boolean`	`contains(T item)` Returns `true` if this range contains the specified item; false otherwise.
`boolean`	`equals(Object o)`
`T`	`first()` Returns the first item in the range.
`int`	`hashCode()`
`boolean`	`intersects(com.hp.util.ip.AbstractRange<T> other)`
`Iterator<Vni>`	`iterator()` Returns an iterator for the range.
`T`	`last()` Returns the last item in the range.
`protected void`	`parseSpec(String spec)` Subclasses should parse the specification, setting the fields `first`, `last`, and `size` appropriately.
`Vni`	`random()` Returns a randomly generated item that falls within this range.
`long`	`size()` Returns the size of the range.
`protected String[]`	`splitSpec(String spec)` Convenience method to split the given string using hyphen as the delimiter.
`String`	`toDebugString()` Returns a multi-line string representing the internal state of this range.
`String`	`toString()`
`static VniRange`	`valueOf(String spec)` Returns a Virtual Network Identifier (VNI) range instance, representing a range of VNI values.
`static VniRange`	`valueOf(Vni first, Vni last)` Returns a Virtual Network Identifier (VNI) range instance, representing a range of VNI values from `first` to `last`, inclusively.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - E_BAD_SPEC
```
protected static final String E_BAD_SPEC
```
    Exception message prefix for bad specification string.
    
    See Also:
    Constant Field Values
  - FIRST
```
protected static final int FIRST
```
    Index for first item returned by splitSpec(String).
    
    See Also:
    Constant Field Values
  - LAST
```
protected static final int LAST
```
    Index for last item returned by splitSpec(String).
    
    See Also:
    Constant Field Values
  - HYPHEN
```
protected static final String HYPHEN
```
    The hyphen character, "-".
    
    See Also:
    Constant Field Values
  - RANDOM
```
protected static final Random RANDOM
```
    Random number generator.
  - spec
```
protected final String spec
```
  - first
```
protected T extends Comparable<T> first
```
  - last
```
protected T extends Comparable<T> last
```
  - size
```
protected int size
```
- Method Detail
  - parseSpec
```
protected void parseSpec(String spec)
```
    Subclasses should parse the specification, setting the fields first, last, and size appropriately. This method is invoked from the constructor.
    
    Parameters:
    spec - the range specification
  - random
```
public Vni random()
```
    Returns a randomly generated item that falls within this range.
    
    Returns:
    a random item within this range
  - iterator
```
public Iterator<Vni> iterator()
```
    Returns an iterator for the range. The iterator will return successive items starting with the first() and ending with the last(), emitting a total count of size() items.
    
    Returns:
    an iterator for the range
  - valueOf
```
public static VniRange valueOf(String spec)
```
    Returns a Virtual Network Identifier (VNI) range instance, representing a range of VNI values. The specification should be of the form:
```
     "{first}-{last}"
 
```
    Parameters:
    spec - the range specification
    
    Returns:
    the range instance
  - valueOf
```
public static VniRange valueOf(Vni first,
               Vni last)
```
    Returns a Virtual Network Identifier (VNI) range instance, representing a range of VNI values from first to last, inclusively.
    
    Parameters:
    first - the first Vni in the range
    last - the last Vni in the range
    
    Returns:
    the range instance
    
    Throws:
    
    NullPointerException - if either parameter is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toDebugString
```
public String toDebugString()
```
    Returns a multi-line string representing the internal state of this range.
    
    Returns:
    the debug string
  - splitSpec
```
protected String[] splitSpec(String spec)
```
    Convenience method to split the given string using hyphen as the delimiter. Throws an exception if the spec cannot be split into two non-empty strings.
    
    Parameters:
    spec - the range specification
    
    Returns:
    an array containing the first and second strings
  - first
```
public T first()
```
    Returns the first item in the range.
    
    Returns:
    the first item in the range
  - last
```
public T last()
```
    Returns the last item in the range.
    
    Returns:
    the last item in the range
  - size
```
public long size()
```
    Returns the size of the range. In other words, how many items are represented by the range.
    
    Returns:
    the size of the range
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - contains
```
public boolean contains(T item)
```
    Returns true if this range contains the specified item; false otherwise.
    
    Parameters:
    item - the item to test
    
    Returns:
    true if the item is contained by this range
  - contains
```
public boolean contains(com.hp.util.ip.AbstractRange<T> other)
```
    Returns true if this range is a superset of the other range; false otherwise. Put another way, the set of all items T_other produced by other.iterator() is a subset of the set of all items T_this produced by this.iterator().
    
    Parameters:
    other - the other range to compare with
    
    Returns:
    true if this range is a superset of the other range
    
    Throws:
    
    IllegalArgumentException - if other range is not the same type as this one
    
    NullPointerException - if other is null
  - intersects
```
public boolean intersects(com.hp.util.ip.AbstractRange<T> other)
```

Class VniRange

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

E_BAD_SPEC

FIRST

LAST

HYPHEN

RANDOM

spec

first

last

size

Method Detail

parseSpec

random

iterator

valueOf

valueOf

toString

toDebugString

splitSpec

first

last

size

equals

hashCode

contains

contains

intersects