org.apache.commons.codec.binary

Class Hex

public class Hex extends Object implements BinaryEncoder, BinaryDecoder

Hex encoder and decoder.

Since: 1.1

Version: $Id: Hex.java 130359 2004-04-18 18:22:33Z ggregory $

Author: Apache Software Foundation

Field Summary
static char[]DIGITS
Used building output as Hex
Method Summary
byte[]decode(byte[] array)
Converts an array of character bytes representing hexidecimal values into an array of bytes of those same values.
Objectdecode(Object object)
Converts a String or an array of character bytes representing hexidecimal values into an array of bytes of those same values.
static byte[]decodeHex(char[] data)
Converts an array of characters representing hexidecimal values into an array of bytes of those same values.
byte[]encode(byte[] array)
Converts an array of bytes into an array of bytes for the characters representing the hexidecimal values of each byte in order.
Objectencode(Object object)
Converts a String or an array of bytes into an array of characters representing the hexidecimal values of each byte in order.
static char[]encodeHex(byte[] data)
Converts an array of bytes into an array of characters representing the hexidecimal values of each byte in order.
protected static inttoDigit(char ch, int index)
Converts a hexadecimal character to an integer.

Field Detail

DIGITS

private static final char[] DIGITS
Used building output as Hex

Method Detail

decode

public byte[] decode(byte[] array)
Converts an array of character bytes representing hexidecimal values into an array of bytes of those same values. The returned array will be half the length of the passed array, as it takes two characters to represent any given byte. An exception is thrown if the passed char array has an odd number of elements.

Parameters: array An array of character bytes containing hexidecimal digits

Returns: A byte array containing binary data decoded from the supplied byte array (representing characters).

Throws: DecoderException Thrown if an odd number of characters is supplied to this function

See Also: (char[])

decode

public Object decode(Object object)
Converts a String or an array of character bytes representing hexidecimal values into an array of bytes of those same values. The returned array will be half the length of the passed String or array, as it takes two characters to represent any given byte. An exception is thrown if the passed char array has an odd number of elements.

Parameters: object A String or, an array of character bytes containing hexidecimal digits

Returns: A byte array containing binary data decoded from the supplied byte array (representing characters).

Throws: DecoderException Thrown if an odd number of characters is supplied to this function or the object is not a String or char[]

See Also: (char[])

decodeHex

public static byte[] decodeHex(char[] data)
Converts an array of characters representing hexidecimal values into an array of bytes of those same values. The returned array will be half the length of the passed array, as it takes two characters to represent any given byte. An exception is thrown if the passed char array has an odd number of elements.

Parameters: data An array of characters containing hexidecimal digits

Returns: A byte array containing binary data decoded from the supplied char array.

Throws: DecoderException Thrown if an odd number or illegal of characters is supplied

encode

public byte[] encode(byte[] array)
Converts an array of bytes into an array of bytes for the characters representing the hexidecimal 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: array a byte[] to convert to Hex characters

Returns: A byte[] containing the bytes of the hexidecimal characters

See Also: (byte[])

encode

public Object encode(Object object)
Converts a String or an array of bytes into an array of characters representing the hexidecimal values of each byte in order. The returned array will be double the length of the passed String or array, as it takes two characters to represent any given byte.

Parameters: object a String, or byte[] to convert to Hex characters

Returns: A char[] containing hexidecimal characters

Throws: EncoderException Thrown if the given object is not a String or byte[]

See Also: (byte[])

encodeHex

public static char[] encodeHex(byte[] data)
Converts an array of bytes into an array of characters representing the hexidecimal 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 hexidecimal characters

toDigit

protected static int toDigit(char ch, int index)
Converts a hexadecimal character to an integer.

Parameters: ch A character to convert to an integer digit index The index of the character in the source

Returns: An integer

Throws: DecoderException Thrown if ch is an illegal hex character

commons-codec version 1.3 - Copyright © 2002-2004 - Apache Software Foundation