com.hfg.util

Class ByteUtil

java.lang.Object

com.hfg.util.ByteUtil

public class ByteUtil
extends Object

General byte utility functions.

Constructor Summary

Constructors

Constructor and Description
ByteUtil()

Method Summary

Modifier and Type	Method and Description
static int	get1ByteInt(byte[] inBytes, int inOffset) Returns a 1-byte int from the given byte array.
static int	get2ByteInt(byte[] inBytes) Returns a 2-byte int from the given byte array.
static int	get2ByteInt(byte[] inBytes, ByteOrder inByteOrder) Returns a 2-byte int from the given byte[].
static int	get2ByteInt(byte[] inBytes, int inOffset) Returns a 2-byte int from the given byte array.
static int	get2ByteInt(byte[] inBytes, int inOffset, ByteOrder inByteOrder) Returns a 2-byte int from the given byte[].
static int	get2ByteInt(ByteSource inByteSource, ByteOrder inByteOrder) Returns a 2-byte int from the current position of the specified ByteSource.
static int	get2ByteInt(InputStream inStream) Returns a 2-byte int from the given InputStream.
static int	get2ByteInt(InputStream inStream, ByteOrder inByteOrder) Returns a 2-byte int from the given InputStream.
static int	get2ByteInt(RandomAccessFile inRandomAccessFile, ByteOrder inByteOrder) Returns a 2-byte int from the current position of the specified RandomAccessFile.
static byte[]	get4bitBytes(byte inByte) Decomposes a byte (8-bits) into two 4-bit bytes.
static String	getBitString(byte inByte) Returns a string like "10110011" to represent the specified 8-bit byte.
static byte	getByteFromBitString(String inByteString) Returns the 8-bit byte corresponding to a specified string like "10110011".
static byte[]	getBytesFromInt(int inValue) Returns a byte[] corresponding to an int.
static char[]	getCharArray(ByteSource inByteSource, int inNumValues) Returns a char[] derived from the specified ByteSource.
static char[]	getCharArray(RandomAccessFile inRandomAccessFile, int inNumValues) Returns a char[] derived from the specified RandomAccessFile.
static float	getFloat(InputStream inStream, ByteOrder inByteOrder) Returns a float from the given byte array.
static String	getHexString(byte[] inBytes) Returns a hex string representing the given byte array.
static int	getInt(byte[] inBytes, int inOffset, ByteOrder inByteOrder) Returns an int from the given byte array.
static int	getInt(ByteSource inByteSource, ByteOrder inByteOrder) Returns an int from the current position of the specified ByteSource.
static int	getInt(InputStream inStream, ByteOrder inByteOrder) Returns an int from the given byte array.
static int	getInt(RandomAccessFile inRandomAccessFile) Returns an int from the current position of the specified RandomAccessFile.
static int	getInt(RandomAccessFile inRandomAccessFile, ByteOrder inByteOrder) Returns an int from the current position of the specified RandomAccessFile.
static long	getLong(ByteSource inByteSource, ByteOrder inByteOrder) Returns an long from the current position of the specified ByteSource.
static long	getLong(RandomAccessFile inRandomAccessFile, ByteOrder inByteOrder) Returns an long from the current position of the specified RandomAccessFile.
static short	getShort(byte[] inBytes) Returns a short from the first 2 bytes of the given byte array.
static short	getShort(byte[] inBytes, int inOffset) Returns a short from the first 2 bytes of the given byte array.
static short	getShort(byte[] inBytes, int inOffset, ByteOrder inByteOrder) Returns a short from the first 2 bytes of the given byte array.
static short[]	getShortArray(byte[] inBytes, int inNumValues, ByteOrder inByteOrder) Returns a short[] derived from the specified byte[].
static short[]	getShortArray(ByteSource inByteSource, int inNumValues, ByteOrder inByteOrder) Returns a short[] derived from the specified ByteSource.
static short[]	getShortArray(RandomAccessFile inRandomAccessFile, int inNumValues, ByteOrder inByteOrder) Returns a short[] derived from the specified RandomAccessFile.
static String	getString(byte[] inBytes, int inOffset, int inLength, ByteOrder inByteOrder) Returns a string from the bytes.
static String	getString(ByteSource inByteSource, int inLength) Returns a String from the current position of the specified ByteSource.
static String	getString(InputStream inStream, int inLength) Returns a string from the bytes.
static String	getString(RandomAccessFile inRandomAccessFile, int inLength) Returns a String from the current position of the specified RandomAccessFile.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteUtil

public ByteUtil()

Method Detail

getBitString

public static String getBitString(byte inByte)

Returns a string like "10110011" to represent the specified 8-bit byte.

Parameters:

inByte - the byte to be represented as a bit string

Returns:

the bit string representing the specified byte

getByteFromBitString

public static byte getByteFromBitString(String inByteString)

Returns the 8-bit byte corresponding to a specified string like "10110011".

Parameters:

inByteString - the bit string to be converted to a byte

Returns:

the byte represented by the specified bit string

get4bitBytes

public static byte[] get4bitBytes(byte inByte)

Decomposes a byte (8-bits) into two 4-bit bytes.

Parameters:

inByte - the source byte to be converted

Returns:

the byte array (length of 2) of 4-bit bytes

getHexString

public static String getHexString(byte[] inBytes)

Returns a hex string representing the given byte array.

Parameters:

inBytes - the source byte array

Returns:

the hexadecimal string represented by the the specified byte array.

getInt

public static int getInt(byte[] inBytes,
                         int inOffset,
                         ByteOrder inByteOrder)

Returns an int from the given byte array.

Parameters:

inBytes - the source byte array

inOffset - the offset within the source byte array from which to extract the int

inByteOrder - the byte order of the int

Returns:

the integer represented by the the specified byte array.

getInt

public static int getInt(InputStream inStream,
                         ByteOrder inByteOrder)
                  throws IOException

Returns an int from the given byte array.

Parameters:

inStream - the InputStream source of bytes

inByteOrder - the byte order of the int

Returns:

the integer represented by the next 4 bytes from the specified InputStream

Throws:

IOException

getInt

public static int getInt(RandomAccessFile inRandomAccessFile)
                  throws IOException

Returns an int from the current position of the specified RandomAccessFile.

Parameters:

inRandomAccessFile - the source of bytes

Returns:

the integer represented in the next 4 bytes of the specified RandomAccessFile

Throws:

IOException

getInt

public static int getInt(RandomAccessFile inRandomAccessFile,
                         ByteOrder inByteOrder)
                  throws IOException

Returns an int from the current position of the specified RandomAccessFile.

Parameters:

inRandomAccessFile - the source of bytes

inByteOrder - the byte order of the int

Returns:

the integer represented in the next 4 bytes of the specified RandomAccessFile

Throws:

IOException

getInt

public static int getInt(ByteSource inByteSource,
                         ByteOrder inByteOrder)
                  throws IOException

Returns an int from the current position of the specified ByteSource.

Parameters:

inByteSource - the source of bytes

inByteOrder - the byte order of the int

Returns:

the integer represented in the next 4 bytes of the specified ByteSource

Throws:

IOException

getLong

public static long getLong(RandomAccessFile inRandomAccessFile,
                           ByteOrder inByteOrder)
                    throws IOException

Returns an long from the current position of the specified RandomAccessFile.

Parameters:

inRandomAccessFile - the source of bytes

inByteOrder - the byte order of the long

Returns:

the long represented in the next 8 bytes of the specified RandomAccessFile

Throws:

IOException

getLong

public static long getLong(ByteSource inByteSource,
                           ByteOrder inByteOrder)
                    throws IOException

Returns an long from the current position of the specified ByteSource.

Parameters:

inByteSource - the source of bytes

inByteOrder - the byte order of the long

Returns:

the long represented in the next 8 bytes of the specified ByteSource

Throws:

IOException

get2ByteInt

public static int get2ByteInt(byte[] inBytes)

Returns a 2-byte int from the given byte array.

Parameters:

inBytes - the source byte array

Returns:

the 2-byte integer represented in the first two bytes of the specified byte array

get2ByteInt

public static int get2ByteInt(byte[] inBytes,
                              ByteOrder inByteOrder)
                       throws IOException

Returns a 2-byte int from the given byte[].

Parameters:

inBytes - the source byte array

inByteOrder - the byte order of the int

Returns:

the 2-byte integer represented in the first two bytes of the specified byte array

Throws:

IOException

get2ByteInt

public static int get2ByteInt(byte[] inBytes,
                              int inOffset,
                              ByteOrder inByteOrder)
                       throws IOException

Returns a 2-byte int from the given byte[].

Parameters:

inBytes - the source byte array

inOffset - the offset within the source byte array from which to extract the int

inByteOrder - the byte order of the int

Returns:

the 2-byte integer represented in the first two bytes of the specified byte array

Throws:

IOException

get2ByteInt

public static int get2ByteInt(InputStream inStream)
                       throws IOException

Returns a 2-byte int from the given InputStream.

Parameters:

inStream - the InputStream source of bytes

Returns:

the 2-byte integer represented in the next two bytes of the specified stream

Throws:

IOException

get2ByteInt

public static int get2ByteInt(InputStream inStream,
                              ByteOrder inByteOrder)
                       throws IOException

Returns a 2-byte int from the given InputStream.

Parameters:

inStream - the InputStream source of bytes

inByteOrder - the byte order of the int

Returns:

the 2-byte integer represented in the next two bytes of the specified stream

Throws:

IOException

get2ByteInt

public static int get2ByteInt(RandomAccessFile inRandomAccessFile,
                              ByteOrder inByteOrder)
                       throws IOException

Returns a 2-byte int from the current position of the specified RandomAccessFile.

Parameters:

inRandomAccessFile - the source of bytes

inByteOrder - the byte order of the int

Returns:

the 2-byte integer represented in the next two bytes of the specified stream

Throws:

IOException

get2ByteInt

public static int get2ByteInt(ByteSource inByteSource,
                              ByteOrder inByteOrder)
                       throws IOException

Returns a 2-byte int from the current position of the specified ByteSource.

Parameters:

inByteSource - the source of bytes

inByteOrder - the byte order of the int

Returns:

the 2-byte integer represented in the next two bytes of the specified ByteSource

Throws:

IOException

get2ByteInt

public static int get2ByteInt(byte[] inBytes,
                              int inOffset)

Returns a 2-byte int from the given byte array.

Parameters:

inBytes - the source byte array

inOffset - the offset within the source byte array from which to extract the int

Returns:

the 2-byte integer represented in the first two bytes at the specified offset of the specified byte array

get1ByteInt

public static int get1ByteInt(byte[] inBytes,
                              int inOffset)

Returns a 1-byte int from the given byte array.

Parameters:

inBytes - the source byte array

inOffset - the offset within the source byte array from which to extract the int

Returns:

the 1-byte integer represented in the first byte of the specified byte array

getShort

public static short getShort(byte[] inBytes)

Returns a short from the first 2 bytes of the given byte array.

Parameters:

inBytes - the source byte array

Returns:

the sort represented in the first two bytes of the specified byte array

getShort

public static short getShort(byte[] inBytes,
                             int inOffset)

Returns a short from the first 2 bytes of the given byte array.

Parameters:

inBytes - the source byte array

inOffset - the offset within the source byte array from which to extract the int

Returns:

the short represented in the first two bytes at the specified offset of the specified byte array

getShort

public static short getShort(byte[] inBytes,
                             int inOffset,
                             ByteOrder inByteOrder)

Returns a short from the first 2 bytes of the given byte array.

Parameters:

inBytes - the source byte array

inOffset - the offset within the source byte array from which to extract the int

inByteOrder - the byte order of the short

Returns:

the short represented in the first two bytes at the specified offset of the specified byte array

getFloat

public static float getFloat(InputStream inStream,
                             ByteOrder inByteOrder)
                      throws IOException

Returns a float from the given byte array.

Parameters:

inStream - the InputStream source of bytes

inByteOrder - the byte order of the float

Returns:

the float represented by the next 4 bytes from the specified InputStream

Throws:

IOException

getString

public static String getString(byte[] inBytes,
                               int inOffset,
                               int inLength,
                               ByteOrder inByteOrder)

Returns a string from the bytes.

Parameters:

inBytes - the source byte array

inOffset - the offset within the source byte array from which to extract the String

inLength - the number of bytes to include in the String

inByteOrder - the byte order of the string

Returns:

the String represented at the specified offset of the specified byte array

getString

public static String getString(InputStream inStream,
                               int inLength)
                        throws IOException

Returns a string from the bytes.

Parameters:

inStream - the InputStream source of bytes

inLength - the number of bytes to include in the String

Returns:

the String represented at the specified offset of the specified byte array

Throws:

IOException

getString

public static String getString(RandomAccessFile inRandomAccessFile,
                               int inLength)
                        throws IOException

Returns a String from the current position of the specified RandomAccessFile.

Parameters:

inRandomAccessFile - the source of bytes

inLength - the number of bytes to include in the String

Returns:

the String represented at the specified offset of the specified RandomAccessFile

Throws:

IOException

getString

public static String getString(ByteSource inByteSource,
                               int inLength)
                        throws IOException

Returns a String from the current position of the specified ByteSource.

Parameters:

inByteSource - the source of bytes

inLength - the number of bytes to include in the String

Returns:

the String represented at the specified offset of the specified ByteSource

Throws:

IOException

getBytesFromInt

public static byte[] getBytesFromInt(int inValue)
                              throws IOException

Returns a byte[] corresponding to an int.

Parameters:

inValue - the int to decompose into an array of 4 bytes

Returns:

the byte[] represented by the specified int

Throws:

IOException

getShortArray

public static short[] getShortArray(byte[] inBytes,
                                    int inNumValues,
                                    ByteOrder inByteOrder)

Returns a short[] derived from the specified byte[].

Parameters:

inBytes - the source byte array

inNumValues - the number of shorts to extract from the source byte array

inByteOrder - the byte order of the string

Returns:

a short[] derived from the specified byte[]

getShortArray

public static short[] getShortArray(RandomAccessFile inRandomAccessFile,
                                    int inNumValues,
                                    ByteOrder inByteOrder)
                             throws IOException

Returns a short[] derived from the specified RandomAccessFile.

Parameters:

inRandomAccessFile - the source of bytes; assumes that the file is already set to the proper position

inNumValues - the number of shorts to extract from the source byte array

inByteOrder - the byte order of the string

Returns:

a short[] derived from the specified RandomAccessFile

Throws:

IOException

getShortArray

public static short[] getShortArray(ByteSource inByteSource,
                                    int inNumValues,
                                    ByteOrder inByteOrder)
                             throws IOException

Returns a short[] derived from the specified ByteSource.

Parameters:

inByteSource - the source of bytes; assumes that the file is already set to the proper position

inNumValues - the number of shorts to extract from the source byte array

inByteOrder - the byte order of the string

Returns:

a short[] derived from the specified ByteSource

Throws:

IOException

getCharArray

public static char[] getCharArray(RandomAccessFile inRandomAccessFile,
                                  int inNumValues)
                           throws IOException

Returns a char[] derived from the specified RandomAccessFile.

Parameters:

inRandomAccessFile - the source of bytes; assumes that the file is already set to the proper position

inNumValues - the number of shorts to extract from the source byte array

Returns:

a char[] derived from the specified RandomAccessFile

Throws:

IOException

getCharArray

public static char[] getCharArray(ByteSource inByteSource,
                                  int inNumValues)
                           throws IOException

Returns a char[] derived from the specified ByteSource.

Parameters:

inByteSource - the source of bytes; assumes that the file is already set to the proper position

inNumValues - the number of shorts to extract from the source byte array

Returns:

a char[] derived from the specified ByteSource

Throws:

IOException