org.opendaylight.vtn.manager.util

Class ByteUtils

java.lang.Object

org.opendaylight.vtn.manager.util.ByteUtils

public final class ByteUtils
extends Object

ByteUtils class is a collection of utility class fields and methods for byte array handling.

Since:

Lithium

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEX_RADIX Radix to be used in intepreting a hex string.
static String	HEX_SEPARATOR Separator for octets in a hex string.
static char	HEX_SEPARATOR_CHAR A character that separates octets in a hex string.

Method Summary

Methods

Modifier and Type	Method and Description
static byte[]	getBits(byte[] data, int off, int nbits) Read the specified number of bits from the given byte array.
static int	parseHexOctet(String hex) Convert the given hex string as unsigned byte.
static void	setBits(byte[] output, byte[] input, int off, int nbits) Copy bits in the specified input byte array into the specified output array.
static byte[]	toBytes(String hex) Convert the given hex string with ":" inserted into a byte array.
static String	toHexString(byte[] bytes) Convert the given byte array into hex string with ":" inserted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HEX_SEPARATOR_CHAR

public static final char HEX_SEPARATOR_CHAR

A character that separates octets in a hex string.

See Also:

Constant Field Values

HEX_SEPARATOR

public static final String HEX_SEPARATOR

Separator for octets in a hex string.

HEX_RADIX

public static final int HEX_RADIX

Radix to be used in intepreting a hex string.

See Also:

Constant Field Values

Method Detail

toHexString

public static String toHexString(byte[] bytes)

Convert the given byte array into hex string with ":" inserted.

Note that this method returns null if null is passed.

Parameters:

bytes - A byte array.

Returns:

A hex string.

toBytes

public static byte[] toBytes(String hex)

Convert the given hex string with ":" inserted into a byte array.

• null is returned if null is passed.
• An empty byte array is returned if an empty string is passed.

Parameters:

hex - A hex string with ":" inserted.

Returns:

A byte array.

Throws:

NumberFormatException - The given string is not a hex string.

parseHexOctet

public static int parseHexOctet(String hex)

Convert the given hex string as unsigned byte.

Parameters:

hex - A hex string.

Returns:

An integer value.

Throws:

NumberFormatException - The given string could not be converted into an unsigned byte.

getBits

public static byte[] getBits(byte[] data,
             int off,
             int nbits)

Read the specified number of bits from the given byte array.

Parameters:

data - A byte array. Specifying null results in undefined behavior.

off - The bit offset to start fetching bits.

nbits - The number of bits to be fetched.

Returns:

A byte array that contains fetched bits (LSB aligned).

Since:

Beryllium

setBits

public static void setBits(byte[] output,
           byte[] input,
           int off,
           int nbits)

Copy bits in the specified input byte array into the specified output array.

Parameters:

output - A byte array to store bits. Specifying null results in undefined behavior.

input - A byte array to be copied. Bits in this array are expected to be aligned to LSB. Specifying null results in undefined behavior.

off - The bit offset of output to start inserting bits from input.

nbits - The number of bits to be copied.

Since:

Beryllium