com.comcast.oscar.utilities

Class HexString

java.lang.Object

com.comcast.oscar.utilities.HexString

public class HexString
extends java.lang.Object

Author:

Maurice Garcia (maurice.garcia.2015@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	BITS_PER_BYTE
static int	HEX_STRING_1_BYTE_LENGTH

Constructor Summary

Constructors

Constructor and Description
HexString()
HexString(byte bHexBuffer) Add a byte
HexString(byte[] bHexBuffer) Add as a ByteArray
HexString(HexString hsObject) Add another HexString Object

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(byte bValue) Add Single Byte
boolean	add(byte[] bValue) Add ByteArray
boolean	add(java.lang.Integer iValue) Add integer
boolean	add(java.lang.String sValue) Add ASCII String
boolean	add(java.lang.String sValue, boolean boolIncludeTerminationNull) Add String and appends a NULL Terminated byte 0x00
static java.lang.String	asciiToHex(java.lang.String sAscii)
static java.lang.String	asciiToHex(java.lang.String sAscii, java.lang.String sSeperation)
static java.util.List<byte[]>	byteArrayGroup(byte[] bByteArray, int iNumBytesInGroup)
void	clear() Clears Object Buffer
static boolean	containAsciiWhiteSpace(byte[] bByteArray)
static byte[]	fileToByteArray(java.io.File filePointer)
static java.io.InputStream	fileToInputStream(java.io.File filePointer)
static java.lang.Integer	getHexByteLength(java.lang.String sHexString)
java.lang.String	hexCompressed()
java.lang.String	hexDelimited(java.lang.String sDelimter)
static byte[]	inetAddressToByteArray(java.lang.String sInetAddress) Get the ByteArray of an InetAddress IPv4 or IPv6
static byte[]	intToByteArray(int iNumber) Convert Integer to a ByteArray of a Max of 4 bytes
boolean	isEmpty() Checks to see if buffer is empty
static boolean	isHexString(java.lang.String sHexString)
int	length()
int	prefixNullPaddToLength(int iTotalLength)
static byte[]	stripNullTerminatedString(byte[] bString)
int	suffixNullPaddToLength(int iTotalLength)
java.lang.String	toASCII()
java.lang.String	toAsciiBinary()
static java.lang.String	toAsciiBinary(byte[] bytes)
byte[]	toByteArray()
static byte[]	toByteArray(java.lang.String sHexString)
static java.lang.String	toHexString(java.lang.Integer iValue) Method toHexString.
static java.lang.String	toHexString(java.lang.String sValue)
java.util.ArrayList<java.lang.String>	toHexStringList()
static java.lang.String	toInetAddress(byte[] bInetAddress)
int	toInteger()
java.lang.String	toString()
java.lang.String	toString(java.lang.String sSeperation)
static boolean	verifyAsciiPlainText(byte[] bByteArray) Need to make sure that CR,NL and TABS are respected 0x0d = CR 0x0a = NL 0x09 = TAB

Methods inherited from class java.lang.Object

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

Field Detail

BITS_PER_BYTE

public static final java.lang.Integer BITS_PER_BYTE

HEX_STRING_1_BYTE_LENGTH

public static final int HEX_STRING_1_BYTE_LENGTH

See Also:

Constant Field Values

Constructor Detail

HexString

public HexString(byte[] bHexBuffer)

Add as a ByteArray

Parameters:

bHexBuffer -

HexString

public HexString(byte bHexBuffer)

Add a byte

Parameters:

bHexBuffer -

HexString

public HexString(HexString hsObject)

Add another HexString Object

Parameters:

hsObject -

HexString

public HexString()

Method Detail

clear

public void clear()

Clears Object Buffer

isEmpty

public boolean isEmpty()

Checks to see if buffer is empty

Returns:

boolean

add

public boolean add(java.lang.Integer iValue)

Add integer

Parameters:

iValue -

Returns:

boolean

add

public boolean add(java.lang.String sValue,
          boolean boolIncludeTerminationNull)

Add String and appends a NULL Terminated byte 0x00

Parameters:

sValue -

boolIncludeTerminationNull -

Returns:

boolean

add

public boolean add(java.lang.String sValue)

Add ASCII String

Parameters:

sValue -

Returns:

boolean

add

public boolean add(byte[] bValue)

Add ByteArray

Parameters:

bValue -

Returns:

boolean

add

public boolean add(byte bValue)

Add Single Byte

Parameters:

bValue -

Returns:

boolean

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

HexString

toString

public java.lang.String toString(java.lang.String sSeperation)

Parameters:

sSeperation -

Returns:

the hex string with a separation character ':' i.e.: xx:xx:xx

hexCompressed

public java.lang.String hexCompressed()

Returns:

Hex String with no seperation charcter

hexDelimited

public java.lang.String hexDelimited(java.lang.String sDelimter)

Parameters:

sDelimter -

Returns:

String

toHexStringList

public java.util.ArrayList<java.lang.String> toHexStringList()

Returns:

ArrayList

toByteArray

public byte[] toByteArray()

Returns:

byte[]

length

public int length()

Returns:

int

toASCII

public java.lang.String toASCII()

Returns:

String

toInteger

public int toInteger()

Returns:

int

toAsciiBinary

public java.lang.String toAsciiBinary()

Returns:

the binary representation of the HEX String

prefixNullPaddToLength

public int prefixNullPaddToLength(int iTotalLength)

Parameters:

iTotalLength -

Returns:

int

suffixNullPaddToLength

public int suffixNullPaddToLength(int iTotalLength)

Parameters:

iTotalLength -

Returns:

int

toHexString

public static java.lang.String toHexString(java.lang.Integer iValue)

Method toHexString.

Parameters:

iValue - Integer

Returns:

String

toHexString

public static java.lang.String toHexString(java.lang.String sValue)

Parameters:

sValue -

Returns:

String

getHexByteLength

public static java.lang.Integer getHexByteLength(java.lang.String sHexString)

Parameters:

sHexString -

Returns:

Integer

toByteArray

public static byte[] toByteArray(java.lang.String sHexString)

Parameters:

sHexString -

Returns:

byte[]

isHexString

public static boolean isHexString(java.lang.String sHexString)

Parameters:

sHexString -

Returns:

boolean

fileToByteArray

public static byte[] fileToByteArray(java.io.File filePointer)

Parameters:

filePointer -

Returns:

byte[]

fileToInputStream

public static java.io.InputStream fileToInputStream(java.io.File filePointer)

Parameters:

filePointer -

Returns:

InputStream

toInetAddress

public static java.lang.String toInetAddress(byte[] bInetAddress)

Parameters:

bInetAddress -

Returns:

String

asciiToHex

public static java.lang.String asciiToHex(java.lang.String sAscii)

Parameters:

sAscii -

Returns:

String

asciiToHex

public static java.lang.String asciiToHex(java.lang.String sAscii,
                          java.lang.String sSeperation)

Parameters:

sAscii -

sSeperation -

Returns:

String

intToByteArray

public static byte[] intToByteArray(int iNumber)

Convert Integer to a ByteArray of a Max of 4 bytes

Parameters:

iNumber -

Returns:

byte[]

stripNullTerminatedString

public static byte[] stripNullTerminatedString(byte[] bString)

Parameters:

bString -

Returns:

byte[]

inetAddressToByteArray

public static byte[] inetAddressToByteArray(java.lang.String sInetAddress)

Get the ByteArray of an InetAddress IPv4 or IPv6

Parameters:

sInetAddress -

Returns:

byte[]

toAsciiBinary

public static java.lang.String toAsciiBinary(byte[] bytes)

Parameters:

bytes -

Returns:

String

byteArrayGroup

public static java.util.List<byte[]> byteArrayGroup(byte[] bByteArray,
                                    int iNumBytesInGroup)

Parameters:

bByteArray -

iNumBytesInGroup -

Returns:

List

verifyAsciiPlainText

public static boolean verifyAsciiPlainText(byte[] bByteArray)

Need to make sure that CR,NL and TABS are respected 0x0d = CR 0x0a = NL 0x09 = TAB

Parameters:

bByteArray -

Returns:

true is no NON text Char is found with exception of white space

containAsciiWhiteSpace

public static boolean containAsciiWhiteSpace(byte[] bByteArray)

Parameters:

bByteArray -

Returns:

boolean