com.etherios.connector.core.utils

Class ByteUtils

java.lang.Object

com.etherios.connector.core.utils.ByteUtils

public class ByteUtils
extends java.lang.Object

Utility functions that enhance Java bytes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_UNSIGNED_BYTE_AS_INT Maximum value of unsigned byte as integer.
static int	MIN_UNSIGNED_BYTE_AS_INT Minimum value of unsigned byte as integer.

Method Summary

Modifier and Type	Method and Description
static void	appendHexByte(java.lang.StringBuffer sb, byte b) Append the byte to a hexadecimal StringBuilder.
static int	byteArrayToInt(byte[] array, int offset) Convert a byte array to an integer.
static short	byteArrayToShort(byte[] array, int offset) Convert a byte array to a short.
static java.lang.String	byteArrayToVersion(byte[] array) Converts the given version in byte array format to string separated by dots.
static boolean	compareByteArrays(byte[] a, byte[] a2) Returns true if the two specified arrays of bytes are equal to one another.
static java.lang.String	getBits(short n, int offset, int length) Get the first x number of bits of a short.
static int	getMultiByte(byte[] a, int offset, int len) Gets a multi-byte section from a byte array.
static byte[]	intToByteArray(int value) Converts the given Integer into a byte array.
static byte[]	longToByteArray(long value) Converts the given Long into a byte array.
static byte	parseHexByte(java.lang.String s) Converts a hexadecimal String to a byte.
static byte[]	parseHexBytes(java.lang.String s) Converts a hexadecimal String to a byte array.
static void	setMultiByte(byte[] a, int offset, int len, int value) Set an integer into a multi-byte section of a byte array.
static byte[]	shortToByteArray(short value) Converts the given Short into a byte array.
static java.lang.String	toBinaryString(byte n) Convert byte to a binary string
static java.lang.String	toHexString(byte b) Converts a byte to a hexadecimal String.
static java.lang.String	toHexString(byte[] data) Converts a byte array to a hexadecimal String.
static java.lang.String	toHexString(byte[] data, int offset, int length, java.lang.String divider) Converts a byte array to a hexadecimal String.
static java.lang.String	toReadableString(byte[] data) Converts a byte array to a readable String.
static java.lang.String	toReadableString(byte[] data, int offset, int length) Converts a byte array to a readable String.
static byte[]	versionToByteArray(java.lang.String version) Converts the given version string to byte array format.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_UNSIGNED_BYTE_AS_INT

public static final int MAX_UNSIGNED_BYTE_AS_INT

Maximum value of unsigned byte as integer.

See Also:

Constant Field Values

MIN_UNSIGNED_BYTE_AS_INT

public static final int MIN_UNSIGNED_BYTE_AS_INT

Minimum value of unsigned byte as integer.

See Also:

Constant Field Values

Method Detail

appendHexByte

public static void appendHexByte(java.lang.StringBuffer sb,
                                 byte b)

Append the byte to a hexadecimal StringBuilder.

Parameters:

sb - the StringBuilder to append the byte to.

b - the byte to append; assumed to be unsigned.

byteArrayToInt

public static int byteArrayToInt(byte[] array,
                                 int offset)

Convert a byte array to an integer.

Parameters:

array - The byte array to convert.

offset - The offset to start converting.

Returns:

the integer value.

byteArrayToShort

public static short byteArrayToShort(byte[] array,
                                     int offset)

Convert a byte array to a short.

Parameters:

array - the byte array to convert.

offset - the offset to start converting.

Returns:

the short value.

byteArrayToVersion

public static java.lang.String byteArrayToVersion(byte[] array)

Converts the given version in byte array format to string separated by dots.

Parameters:

array - byte array to convert to version.

Returns:

Version as string separated by dots.

compareByteArrays

public static boolean compareByteArrays(byte[] a,
                                        byte[] a2)

Returns true if the two specified arrays of bytes are equal to one another. Two arrays are considered equal if both arrays contain the same number of elements, and all corresponding pairs of elements in the two arrays are equal. In other words, two arrays are equal if they contain the same elements in the same order. Also, two array references are considered equal if both are null.

Parameters:

a - one array to be tested for equality

a2 - the other array to be tested for equality

Returns:

true if the two arrays are equal

getBits

public static java.lang.String getBits(short n,
                                       int offset,
                                       int length)

Get the first x number of bits of a short.

Parameters:

n - The short to get bits from.

offset - The offset to start getting bits.

length - The number of bits to get.

Returns:

he first x number of bits of a short.

getMultiByte

public static int getMultiByte(byte[] a,
                               int offset,
                               int len)

Gets a multi-byte section from a byte array.

Parameters:

a - the byte array to get a multi-byte section of.

offset - the offset into the array of the start of the section.

len - the length of the section; must be <= 4.

Returns:

an int with the value of the section as its low bytes.

Throws:

java.lang.IllegalArgumentException - if len > 4.

java.lang.IndexOutOfBoundsException - if the offset and length arguments index bytes outside the bounds of the data array.

intToByteArray

public static byte[] intToByteArray(int value)

Converts the given Integer into a byte array.

Parameters:

value - Integer value.

Returns:

Integer value as byte array.

longToByteArray

public static byte[] longToByteArray(long value)

Converts the given Long into a byte array.

Parameters:

value - Long value.

Returns:

Long value as byte array.

parseHexByte

public static byte parseHexByte(java.lang.String s)

Converts a hexadecimal String to a byte.

Parameters:

s - the String to convert. Must be exactly 2 characters long.

Returns:

the byte that String represents.

Throws:

java.lang.IllegalArgumentException - if s does not represent a hexadecimal String.

parseHexBytes

public static byte[] parseHexBytes(java.lang.String s)

Converts a hexadecimal String to a byte array.

Parameters:

s - the String to convert. Must be a multiple of 2 characters long.

Returns:

the byte array that String represents.

Throws:

java.lang.IllegalArgumentException - if s does not represent a hexadecimal String.

setMultiByte

public static void setMultiByte(byte[] a,
                                int offset,
                                int len,
                                int value)

Set an integer into a multi-byte section of a byte array.

Parameters:

a - the byte array to set a multi-byte section of.

offset - the offset into the array of the start of the section.

len - the length of the section; must be <= 4.

value - the value whose low bytes should be set in the array.

Throws:

java.lang.IllegalArgumentException - if len > 4.

java.lang.IndexOutOfBoundsException - if the offset and length arguments index bytes outside the bounds of the data array.

shortToByteArray

public static byte[] shortToByteArray(short value)

Converts the given Short into a byte array.

Parameters:

value - Short value.

Returns:

Short value as byte array.

toBinaryString

public static java.lang.String toBinaryString(byte n)

Convert byte to a binary string

Parameters:

n - Byte to convert to binary string.

Returns:

Binary string representation of byte n.

toHexString

public static java.lang.String toHexString(byte b)

Converts a byte to a hexadecimal String.

Parameters:

b - the byte to convert; assumed to be unsigned.

Returns:

a two character String with the value of the byte in hexadecimal. Letters are uppercase;

toHexString

public static java.lang.String toHexString(byte[] data)

Converts a byte array to a hexadecimal String. Each byte is converted to a two character String with uppercase letters. Nothing is inserted between bytes.

Parameters:

data - the byte array to convert.

Returns:

a String with the value of the bytes in hexadecimal.

toHexString

public static java.lang.String toHexString(byte[] data,
                                           int offset,
                                           int length,
                                           java.lang.String divider)

Converts a byte array to a hexadecimal String. Each byte is converted to a two character String with uppercase letters.

Parameters:

data - the byte array to convert.

offset - the index of the first byte to convert.

length - the number of bytes to convert.

divider - a String to insert between each byte, or null if no divider should be inserted.

Returns:

a String with the value of the bytes in hexadecimal.

Throws:

java.lang.IndexOutOfBoundsException - if the offset and length arguments index bytes outside the bounds of the data array.

toReadableString

public static java.lang.String toReadableString(byte[] data)

Converts a byte array to a readable String. If a byte represents an ASCII character that can be printed in one character width, it is printed; otherwise it is replaced with a period.

Parameters:

data - the byte array to convert.

Returns:

a String representing the byte array.

toReadableString

public static java.lang.String toReadableString(byte[] data,
                                                int offset,
                                                int length)

Converts a byte array to a readable String. If a byte represents an ASCII character that can be printed in one character width, it is printed; otherwise it is replaced with a period.

Parameters:

data - the byte array to convert.

offset - the index of the first byte to convert.

length - the number of bytes to convert.

Returns:

a String representing the byte array.

Throws:

java.lang.IndexOutOfBoundsException - if the offset and length arguments index bytes outside the bounds of the data array.

versionToByteArray

public static byte[] versionToByteArray(java.lang.String version)
                                 throws java.lang.NumberFormatException

Converts the given version string to byte array format.

Parameters:

version - Version string to convert.

Returns:

Version as byte array.

Throws:

java.lang.NumberFormatException - if the provided version string does not follow the format x.x.x.x (where x are integer values)