ca.randolf.util

Class ByteTools

Object

ca.randolf.util.ByteTools

public class ByteTools
extends Object

This class provides static methods that make it easier to work with bytes or groups of bytes. Since working with individual bytes is relatively easy, our emphasis is primarily on groups of bytes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION Version number of this Package (read-only).

Method Summary

Modifier and Type	Method and Description
static byte[]	compress(byte... data) Compresses the provided byte[] array using the GZIP algorithm.
static java.io.ByteArrayOutputStream	compressToStream(byte... data) Compresses the provided byte[] array using the GZIP algorithm.
static byte[]	decompress(byte... data) Decompresses the provided byte[] array using the GZIP algorithm.
static java.io.ByteArrayOutputStream	decompressToStream(byte... data) Decompresses the provided byte[] array using the GZIP algorithm.
static String[]	stringsFromByteArray(byte... b) Separates any number of Strings from a byte[] array of ASCIIZ Strings (each String in the byte[] array is terminated by byte 0).
static byte[]	stringsToByteArray(String... ss) Joins any number of Strings into a byte[] array of ASCIIZ Strings (each String in the byte[] array is terminated by byte 0).
static byte[]	toArray(byte... p) Returns any number of byte primitives as a byte[] array.
static byte[]	toArray(double... p) Returns any number of double primitives as a byte[] array.
static byte[]	toArray(float... p) Returns any number of float primitives as a byte[] array.
static byte[]	toArray(int... p) Returns any number of int primitives as a byte[] array.
static byte[]	toArray(long... p) Returns any number of long primitives as a byte[] array.
static byte[]	toArray(short... p) Returns any number of short primitives as a byte[] array.
static String	toDebugString(byte... data) Returns a byte[] array transposed into a String, with functional characters converted to intuitive non-functional human-readable character sequences.
static String	toDebugString(int begin, byte... data) Returns a byte[] array transposed into a String, with functional characters converted to intuitive non-functional human-readable character sequences.
static String	toDebugString(int begin, int size, byte... data) Returns a byte[] array transposed into a String, with functional characters converted to intuitive non-functional human-readable character sequences.
static String	toHexString(byte... data) Returns a byte[] array transposed into a String of hexadecimal digit pairs as one continuous sequence of characters, with colons inserted between each pair of two lower-case hexadecimal digits.
static String	toHexString(int begin, byte... data) Returns a byte[] array transposed into a String of hexadecimal digit pairs as one continuous sequence of characters, with colons inserted between each pair of two lower-case hexadecimal digits.
static String	toHexString(int begin, int size, byte... data) Returns a byte[] array transposed into a String of hexadecimal digit pairs as one continuous sequence of characters, with colons inserted between each pair of two lower-case hexadecimal digits.
static String	toHexString(int flags, int begin, int size, byte... data) Returns a byte[] array transposed into a String of hexadecimal digit pairs as one continuous sequence of characters with certain customization options.

Methods inherited from class Object

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

Field Detail

VERSION

public static final String VERSION

Version number of this Package (read-only).

See Also:

Constant Field Values

Method Detail

compress

public static byte[] compress(byte... data)

Compresses the provided byte[] array using the GZIP algorithm.

Parameters:

data - The byte[] array to compress

Returns:

byte[] Compressed data

compressToStream

public static java.io.ByteArrayOutputStream compressToStream(byte... data)

Compresses the provided byte[] array using the GZIP algorithm.

Parameters:

data - The byte[] array to compress

Returns:

ByteArrayOutputStream Compressed data as an OutputStream

decompress

public static byte[] decompress(byte... data)
                         throws java.util.zip.ZipException

Decompresses the provided byte[] array using the GZIP algorithm.

Parameters:

data - The byte[] array to decompress

Returns:

byte[] Decompressed data

Throws:

java.util.zip.ZipException - If the data is not GZIP formatted or is otherwise corrupt in some manner

decompressToStream

public static java.io.ByteArrayOutputStream decompressToStream(byte... data)
                                                        throws java.util.zip.ZipException

Decompresses the provided byte[] array using the GZIP algorithm.

Parameters:

data - The byte[] array to decompress

Returns:

ByteArrayInputStream Decompressed data as an InputStream

Throws:

java.util.zip.ZipException - If the data is not GZIP formatted or is otherwise corrupt in some manner

stringsFromByteArray

public static String[] stringsFromByteArray(byte... b)

Separates any number of Strings from a byte[] array of ASCIIZ Strings (each String in the byte[] array is terminated by byte 0).

Note: If the byte[] array is not empty, and the final byte is not 0, then the array will be treated as if a final 0 byte is present after the array.

Parameters:

b - The byte[] array to parse

Returns:

the new array

stringsToByteArray

public static byte[] stringsToByteArray(String... ss)

Joins any number of Strings into a byte[] array of ASCIIZ Strings (each String in the byte[] array is terminated by byte 0).

Parameters:

ss - The String objects to join

Returns:

the new array

toArray

public static byte[] toArray(byte... p)

Returns any number of byte primitives as a byte[] array.

Parameters:

p - Primitive values

Returns:

All data returned as a byte[] array

toArray

public static byte[] toArray(double... p)

Returns any number of double primitives as a byte[] array.

Parameters:

p - Primitive values

Returns:

All data returned as a byte[] array

toArray

public static byte[] toArray(float... p)

Returns any number of float primitives as a byte[] array.

Parameters:

p - Primitive values

Returns:

All data returned as a byte[] array

toArray

public static byte[] toArray(int... p)

Returns any number of int primitives as a byte[] array.

Parameters:

p - Primitive values

Returns:

All data returned as a byte[] array

toArray

public static byte[] toArray(long... p)

Returns any number of long primitives as a byte[] array.

Parameters:

p - Primitive values

Returns:

All data returned as a byte[] array

toArray

public static byte[] toArray(short... p)

Returns any number of short primitives as a byte[] array.

Parameters:

p - Primitive values

Returns:

All data returned as a byte[] array

toDebugString

public static String toDebugString(byte... data)

Returns a byte[] array transposed into a String, with functional characters converted to intuitive non-functional human-readable character sequences.

Parameters:

data - The byte[] array to transpose

Returns:

String that is useful for debug output

toDebugString

public static String toDebugString(int begin,
                                   byte... data)

Returns a byte[] array transposed into a String, with functional characters converted to intuitive non-functional human-readable character sequences.

Parameters:

begin - The first element in the array to start from (0 = first element)

data - The byte[] array to transpose

Returns:

String that is useful for debug output

toDebugString

public static String toDebugString(int begin,
                                   int size,
                                   byte... data)

Returns a byte[] array transposed into a String, with functional characters converted to intuitive non-functional human-readable character sequences.

Parameters:

begin - The first element in the array to start from (0 = first element)

size - The total number of elements to transpose (or specify -1 for all)

data - The byte[] array to transpose

Returns:

String that is useful for debug output

toHexString

public static String toHexString(byte... data)

Returns a byte[] array transposed into a String of hexadecimal digit pairs as one continuous sequence of characters, with colons inserted between each pair of two lower-case hexadecimal digits.

Parameters:

data - The byte[] array to transpose

Returns:

String that is useful for human-readable output

toHexString

public static String toHexString(int begin,
                                 byte... data)

Returns a byte[] array transposed into a String of hexadecimal digit pairs as one continuous sequence of characters, with colons inserted between each pair of two lower-case hexadecimal digits.

Parameters:

begin - The first element in the array to start from (0 = first element)

data - The byte[] array to transpose

Returns:

String that is useful for human-readable output

toHexString

public static String toHexString(int begin,
                                 int size,
                                 byte... data)

Returns a byte[] array transposed into a String of hexadecimal digit pairs as one continuous sequence of characters, with colons inserted between each pair of two lower-case hexadecimal digits.

Parameters:

begin - The first element in the array to start from (0 = first element)

size - The total number of elements to transpose (or specify -1 for all)

data - The byte[] array to transpose

Returns:

String that is useful for human-readable output

toHexString

public static String toHexString(int flags,
                                 int begin,
                                 int size,
                                 byte... data)

Returns a byte[] array transposed into a String of hexadecimal digit pairs as one continuous sequence of characters with certain customization options.

Parameters:

flags - Various configuration flags; 1 = Insert a colon (":") delimiter between each byte; 2 = Upper case; 4 = Omit leading zeros from digit pairs

begin - The first element in the array to start from (0 = first element)

size - The total number of elements to transpose (or specify -1 for all)

data - The byte[] array to transpose

Returns:

String that is useful for human-readable output