ImmutableByteSequence (onlab-misc)

java.lang.Object
- org.onlab.util.ImmutableByteSequence

```
public final class ImmutableByteSequence
extends java.lang.Object
```
Immutable sequence of bytes, assumed to represent a value in BIG_ENDIAN order.
Sequences can be created copying from an already existing representation of a sequence of bytes, such as ByteBuffer or byte[]; or by copying bytes from a primitive data type, such as long, int or short. In the first case, bytes are assumed to be already given in big-endian order, while in the second case big-endianness is enforced by this class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`asArray()` Creates a new byte array view of this sequence.
`java.nio.ByteBuffer`	`asReadOnlyBuffer()` Returns a view of this sequence as a read-only `ByteBuffer`.
`static ImmutableByteSequence`	`copyFrom(byte original)` Creates a new byte sequence of 1 byte containing the given value.
`static ImmutableByteSequence`	`copyFrom(byte[] original)` Creates a new immutable byte sequence with the same content and order of the passed byte array.
`static ImmutableByteSequence`	`copyFrom(byte[] original, int fromIdx, int toIdx)` Creates a new immutable byte sequence with the same content and order of the passed byte array, from/to the given indexes (inclusive).
`static ImmutableByteSequence`	`copyFrom(java.nio.ByteBuffer original)` Creates a new immutable byte sequence copying bytes from the given ByteBuffer `ByteBuffer`.
`static ImmutableByteSequence`	`copyFrom(int original)` Creates a new byte sequence of 4 bytes containing the given int value.
`static ImmutableByteSequence`	`copyFrom(long original)` Creates a new byte sequence of 8 bytes containing the given long value.
`static ImmutableByteSequence`	`copyFrom(short original)` Creates a new byte sequence of 2 bytes containing the given short value.
`boolean`	`equals(java.lang.Object obj)`
`int`	`hashCode()`
`static ImmutableByteSequence`	`ofOnes(int size)` Creates a new byte sequence of the given size where alla bits are 1.
`static ImmutableByteSequence`	`ofZeros(int size)` Creates a new byte sequence of the given size where alla bits are 0.
`int`	`size()` Gets the number of bytes in this sequence.
`java.lang.String`	`toString()`

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

- Method Detail
  - copyFrom
```
public static ImmutableByteSequence copyFrom(byte[] original)
```
    Creates a new immutable byte sequence with the same content and order of the passed byte array.
    
    Parameters:
    
    original - a byte array value
    
    Returns:
    
    a new immutable byte sequence
  - copyFrom
```
public static ImmutableByteSequence copyFrom(byte[] original,
                                             int fromIdx,
                                             int toIdx)
```
    Creates a new immutable byte sequence with the same content and order of the passed byte array, from/to the given indexes (inclusive).
    
    Parameters:
    
    original - a byte array value
    
    fromIdx - starting index
    
    toIdx - ending index
    
    Returns:
    
    a new immutable byte sequence
  - copyFrom
```
public static ImmutableByteSequence copyFrom(java.nio.ByteBuffer original)
```
    Creates a new immutable byte sequence copying bytes from the given ByteBuffer ByteBuffer. If the byte buffer order is not big-endian bytes will be copied in reverse order.
    
    Parameters:
    
    original - a byte buffer
    
    Returns:
    
    a new byte buffer object
  - copyFrom
```
public static ImmutableByteSequence copyFrom(long original)
```
    Creates a new byte sequence of 8 bytes containing the given long value.
    
    Parameters:
    
    original - a long value
    
    Returns:
    
    a new immutable byte sequence
  - copyFrom
```
public static ImmutableByteSequence copyFrom(int original)
```
    Creates a new byte sequence of 4 bytes containing the given int value.
    
    Parameters:
    
    original - an int value
    
    Returns:
    
    a new immutable byte sequence
  - copyFrom
```
public static ImmutableByteSequence copyFrom(short original)
```
    Creates a new byte sequence of 2 bytes containing the given short value.
    
    Parameters:
    
    original - a short value
    
    Returns:
    
    a new immutable byte sequence
  - copyFrom
```
public static ImmutableByteSequence copyFrom(byte original)
```
    Creates a new byte sequence of 1 byte containing the given value.
    
    Parameters:
    
    original - a byte value
    
    Returns:
    
    a new immutable byte sequence
  - ofZeros
```
public static ImmutableByteSequence ofZeros(int size)
```
    Creates a new byte sequence of the given size where alla bits are 0.
    
    Parameters:
    
    size - number of bytes
    
    Returns:
    
    a new immutable byte sequence
  - ofOnes
```
public static ImmutableByteSequence ofOnes(int size)
```
    Creates a new byte sequence of the given size where alla bits are 1.
    
    Parameters:
    
    size - number of bytes
    
    Returns:
    
    a new immutable byte sequence
  - asReadOnlyBuffer
```
public java.nio.ByteBuffer asReadOnlyBuffer()
```
    Returns a view of this sequence as a read-only ByteBuffer.
    The returned buffer will have position 0, while limit and capacity will be set to this sequence size(). The buffer order will be big-endian.
    
    Returns:
    
    a read-only byte buffer
  - size
```
public int size()
```
    Gets the number of bytes in this sequence.
    
    Returns:
    
    an integer value
  - asArray
```
public byte[] asArray()
```
    Creates a new byte array view of this sequence.
    
    Returns:
    
    a new byte array
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ImmutableByteSequence

Method Summary

Methods inherited from class java.lang.Object

Method Detail

copyFrom

copyFrom

copyFrom

copyFrom

copyFrom

copyFrom

copyFrom

ofZeros

ofOnes

asReadOnlyBuffer

size

asArray

hashCode

equals

toString