cn.felord.utils

Class Hex

java.lang.Object

cn.felord.utils.Hex

public class Hex
extends Object

Converts hexadecimal Strings.

This class is thread-safe.

Since:

1.1

Field Summary

Fields

Modifier and Type	Field and Description
private static char[]	DIGITS_LOWER Used to build output as hex.
private static char[]	DIGITS_UPPER Used to build output as hex.

Constructor Summary

Constructors

Constructor and Description
Hex()

Method Summary

Modifier and Type	Method and Description
static char[]	encodeHex(byte[] data) Converts an array of bytes into an array of characters representing the hexadecimal values of each byte in order.
static char[]	encodeHex(byte[] data, boolean toLowerCase) Converts an array of bytes into an array of characters representing the hexadecimal values of each byte in order.
protected static char[]	encodeHex(byte[] data, char[] toDigits) Converts an array of bytes into an array of characters representing the hexadecimal values of each byte in order.
static char[]	encodeHex(byte[] data, int dataOffset, int dataLen, boolean toLowerCase) Converts an array of bytes into an array of characters representing the hexadecimal values of each byte in order.
static void	encodeHex(byte[] data, int dataOffset, int dataLen, boolean toLowerCase, char[] out, int outOffset) Converts an array of bytes into an array of characters representing the hexadecimal values of each byte in order.
private static void	encodeHex(byte[] data, int dataOffset, int dataLen, char[] toDigits, char[] out, int outOffset) Converts an array of bytes into an array of characters representing the hexadecimal values of each byte in order.
static char[]	encodeHex(ByteBuffer data) Converts a byte buffer into an array of characters representing the hexadecimal values of each byte in order.
static char[]	encodeHex(ByteBuffer data, boolean toLowerCase) Converts a byte buffer into an array of characters representing the hexadecimal values of each byte in order.
protected static char[]	encodeHex(ByteBuffer byteBuffer, char[] toDigits) Converts a byte buffer into an array of characters representing the hexadecimal values of each byte in order.
static String	encodeHexString(byte[] data) Converts an array of bytes into a String representing the hexadecimal values of each byte in order.
static String	encodeHexString(byte[] data, boolean toLowerCase) Converts an array of bytes into a String representing the hexadecimal values of each byte in order.
static String	encodeHexString(ByteBuffer data) Converts a byte buffer into a String representing the hexadecimal values of each byte in order.
static String	encodeHexString(ByteBuffer data, boolean toLowerCase) Converts a byte buffer into a String representing the hexadecimal values of each byte in order.
private static byte[]	toByteArray(ByteBuffer byteBuffer) Convert the byte buffer to a byte array.

Methods inherited from class java.lang.Object

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

Field Detail

DIGITS_LOWER

private static final char[] DIGITS_LOWER

Used to build output as hex.

DIGITS_UPPER

private static final char[] DIGITS_UPPER

Used to build output as hex.

Constructor Detail

Hex

public Hex()

Method Detail

encodeHex

public static char[] encodeHex(byte[] data)

Converts an array of bytes into an array of characters representing the hexadecimal values of each byte in order. The returned array will be double the length of the passed array, as it takes two characters to represent any given byte.

Parameters:

data - a byte[] to convert to hex characters

Returns:

A char[] containing lower-case hexadecimal characters

encodeHex

public static char[] encodeHex(byte[] data,
                               boolean toLowerCase)

Converts an array of bytes into an array of characters representing the hexadecimal values of each byte in order. The returned array will be double the length of the passed array, as it takes two characters to represent any given byte.

Parameters:

data - a byte[] to convert to Hex characters

toLowerCase - true converts to lowercase, false to uppercase

Returns:

A char[] containing hexadecimal characters in the selected case

Since:

1.4

encodeHex

protected static char[] encodeHex(byte[] data,
                                  char[] toDigits)

Converts an array of bytes into an array of characters representing the hexadecimal values of each byte in order. The returned array will be double the length of the passed array, as it takes two characters to represent any given byte.

Parameters:

data - a byte[] to convert to hex characters

toDigits - the output alphabet (must contain at least 16 chars)

Returns:

A char[] containing the appropriate characters from the alphabet For best results, this should be either upper- or lower-case hex.

Since:

1.4

encodeHex

public static char[] encodeHex(byte[] data,
                               int dataOffset,
                               int dataLen,
                               boolean toLowerCase)

Converts an array of bytes into an array of characters representing the hexadecimal values of each byte in order.

Parameters:

data - a byte[] to convert to hex characters

dataOffset - the position in data to start encoding from

dataLen - the number of bytes from dataOffset to encode

toLowerCase - true converts to lowercase, false to uppercase

Returns:

A char[] containing the appropriate characters from the alphabet For best results, this should be either upper- or lower-case hex.

Since:

1.15

encodeHex

public static void encodeHex(byte[] data,
                             int dataOffset,
                             int dataLen,
                             boolean toLowerCase,
                             char[] out,
                             int outOffset)

Converts an array of bytes into an array of characters representing the hexadecimal values of each byte in order.

Parameters:

data - a byte[] to convert to hex characters

dataOffset - the position in data to start encoding from

dataLen - the number of bytes from dataOffset to encode

toLowerCase - true converts to lowercase, false to uppercase

out - a char[] which will hold the resultant appropriate characters from the alphabet.

outOffset - the position within out at which to start writing the encoded characters.

Since:

1.15

encodeHex

private static void encodeHex(byte[] data,
                              int dataOffset,
                              int dataLen,
                              char[] toDigits,
                              char[] out,
                              int outOffset)

Converts an array of bytes into an array of characters representing the hexadecimal values of each byte in order.

Parameters:

data - a byte[] to convert to hex characters

dataOffset - the position in data to start encoding from

dataLen - the number of bytes from dataOffset to encode

toDigits - the output alphabet (must contain at least 16 chars)

out - a char[] which will hold the resultant appropriate characters from the alphabet.

outOffset - the position within out at which to start writing the encoded characters.

encodeHex

public static char[] encodeHex(ByteBuffer data)

Converts a byte buffer into an array of characters representing the hexadecimal values of each byte in order. The returned array will be double the length of the passed array, as it takes two characters to represent any given byte.

All bytes identified by Buffer.remaining() will be used; after this method the value remaining() will be zero.

Parameters:

data - a byte buffer to convert to hex characters

Returns:

A char[] containing lower-case hexadecimal characters

Since:

1.11

encodeHex

public static char[] encodeHex(ByteBuffer data,
                               boolean toLowerCase)

Converts a byte buffer into an array of characters representing the hexadecimal values of each byte in order. The returned array will be double the length of the passed array, as it takes two characters to represent any given byte.

All bytes identified by Buffer.remaining() will be used; after this method the value remaining() will be zero.

Parameters:

data - a byte buffer to convert to hex characters

toLowerCase - true converts to lowercase, false to uppercase

Returns:

A char[] containing hexadecimal characters in the selected case

Since:

1.11

encodeHex

protected static char[] encodeHex(ByteBuffer byteBuffer,
                                  char[] toDigits)

Converts a byte buffer into an array of characters representing the hexadecimal values of each byte in order. The returned array will be double the length of the passed array, as it takes two characters to represent any given byte.

All bytes identified by Buffer.remaining() will be used; after this method the value remaining() will be zero.

Parameters:

byteBuffer - a byte buffer to convert to hex characters

toDigits - the output alphabet (must be at least 16 characters)

Returns:

A char[] containing the appropriate characters from the alphabet For best results, this should be either upper- or lower-case hex.

Since:

1.11

encodeHexString

public static String encodeHexString(byte[] data)

Converts an array of bytes into a String representing the hexadecimal values of each byte in order. The returned String will be double the length of the passed array, as it takes two characters to represent any given byte.

Parameters:

data - a byte[] to convert to hex characters

Returns:

A String containing lower-case hexadecimal characters

Since:

1.4

encodeHexString

public static String encodeHexString(byte[] data,
                                     boolean toLowerCase)

Converts an array of bytes into a String representing the hexadecimal values of each byte in order. The returned String will be double the length of the passed array, as it takes two characters to represent any given byte.

Parameters:

data - a byte[] to convert to hex characters

toLowerCase - true converts to lowercase, false to uppercase

Returns:

A String containing lower-case hexadecimal characters

Since:

1.11

encodeHexString

public static String encodeHexString(ByteBuffer data)

Converts a byte buffer into a String representing the hexadecimal values of each byte in order. The returned String will be double the length of the passed array, as it takes two characters to represent any given byte.

All bytes identified by Buffer.remaining() will be used; after this method the value remaining() will be zero.

Parameters:

data - a byte buffer to convert to hex characters

Returns:

A String containing lower-case hexadecimal characters

Since:

1.11

encodeHexString

public static String encodeHexString(ByteBuffer data,
                                     boolean toLowerCase)

Converts a byte buffer into a String representing the hexadecimal values of each byte in order. The returned String will be double the length of the passed array, as it takes two characters to represent any given byte.

All bytes identified by Buffer.remaining() will be used; after this method the value remaining() will be zero.

Parameters:

data - a byte buffer to convert to hex characters

toLowerCase - true converts to lowercase, false to uppercase

Returns:

A String containing lower-case hexadecimal characters

Since:

1.11

toByteArray

private static byte[] toByteArray(ByteBuffer byteBuffer)

Convert the byte buffer to a byte array. All bytes identified by Buffer.remaining() will be used.

Parameters:

byteBuffer - the byte buffer

Returns:

the byte[]