com.absio.util

Class ByteUtils

java.lang.Object

com.absio.util.ByteUtils

public class ByteUtils
extends Object

This is a utility class for doing byte related operations.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LONG_IN_BYTES

Constructor Summary

Constructors

Constructor and Description
ByteUtils()

Method Summary

Modifier and Type	Method and Description
static long	bytesToLong(byte[] bytes) Convert a byte array into a long using ByteOrder.LITTLE_ENDIAN as the byte order.
static long	bytesToLong(byte[] bytes, int offset) Convert a byte array into a long from the given offset using ByteOrder.LITTLE_ENDIAN as the byte order.
static long	getLong(InputStream input) Read a long out of the given input stream (reading out the number bytes in a long and converting).
static byte[]	getRandomBytes(int length) Creates a byte array 'length' long and populates it with random data.
static boolean	isAllZeros(byte[] bytes) Checks if a byte array contains all zero bytes.
static byte[]	longToBytes(long x) Convert a long into a byte array using ByteOrder.LITTLE_ENDIAN as the byte order.
static byte[]	readBytes(InputStream input) Read all the bytes from the input stream and return as a single byte array.
static byte[]	readBytes(InputStream input, int length) Read 'length' bytes from the input stream and return as a single byte array 'length' long.
static byte[]	readLengthPrefixedData(InputStream input) This will read a long from the input stream.
static void	writeLengthPrefixedData(byte[] data, OutputStream outputStream) This will first write out the length of the data as a long (in bytes) followed by the data itself.

Methods inherited from class java.lang.Object

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

Field Detail

LONG_IN_BYTES

public static final int LONG_IN_BYTES

See Also:

Constant Field Values

Constructor Detail

ByteUtils

public ByteUtils()

Method Detail

bytesToLong

public static long bytesToLong(byte[] bytes)

Convert a byte array into a long using ByteOrder.LITTLE_ENDIAN as the byte order.

Parameters:

bytes - the bytes to convert into a long

Returns:

a long representation of the bytes

bytesToLong

public static long bytesToLong(byte[] bytes,
                               int offset)

Convert a byte array into a long from the given offset using ByteOrder.LITTLE_ENDIAN as the byte order.

Parameters:

bytes - the bytes to convert into a long

offset - the offset in the byte array

Returns:

a long representation of the bytes

getLong

public static long getLong(InputStream input)
                    throws IOException

Read a long out of the given input stream (reading out the number bytes in a long and converting).

Parameters:

input - the input stream to read from

Returns:

the long read out of the input stream

Throws:

IOException - thrown if there was an error reading the bytes

getRandomBytes

public static byte[] getRandomBytes(int length)

Creates a byte array 'length' long and populates it with random data. The JCE is used for the random data (SecureRandom).

Parameters:

length - the size of the random byte array

Returns:

a byte array 'length' long with random data

isAllZeros

public static boolean isAllZeros(byte[] bytes)

Checks if a byte array contains all zero bytes.

Parameters:

bytes -

Returns:

if all zero bytes

longToBytes

public static byte[] longToBytes(long x)

Convert a long into a byte array using ByteOrder.LITTLE_ENDIAN as the byte order.

Parameters:

x - the long to convert into a byte array

Returns:

the long as a byte array

readBytes

public static byte[] readBytes(InputStream input,
                               int length)
                        throws IOException

Read 'length' bytes from the input stream and return as a single byte array 'length' long.

Parameters:

input - the input stream to read bytes from

length - the number of bytes to read from the input stream

Returns:

a byte array 'length' long with the bytes read from the input stream

Throws:

IOException - thrown if there are any issues reading the bytes from the input stream

readBytes

public static byte[] readBytes(InputStream input)
                        throws IOException

Read all the bytes from the input stream and return as a single byte array.

Parameters:

input - the input stream to read bytes from

Returns:

a byte array with all the bytes read from the input stream

Throws:

IOException - thrown if there are any issues reading the bytes from the input stream

readLengthPrefixedData

public static byte[] readLengthPrefixedData(InputStream input)
                                     throws IOException

This will read a long from the input stream. The read long becomes the 'length'. It will the read 'length' bytes from the input stream. The read bytes will be returned as a single byte array.

Parameters:

input - the stream to read from

Returns:

a byte array with the specified amount of data

Throws:

IOException - thrown if there are any errors reading the data from the stream

writeLengthPrefixedData

public static void writeLengthPrefixedData(byte[] data,
                                           OutputStream outputStream)
                                    throws IOException

This will first write out the length of the data as a long (in bytes) followed by the data itself.

Parameters:

data - the data to write out

outputStream - the stream to write to

Throws:

IOException - thrown if there are any errors writing the data to the stream