org.apache.commons.codec.binary

Class BinaryCodec

public class BinaryCodec extends Object implements BinaryDecoder, BinaryEncoder

Translates between byte arrays and strings of "0"s and "1"s.

Since: 1.3

Version: $Id $

Author: Apache Software Foundation

UNKNOWN: may want to add more bit vector functions like and/or/xor/nand also might be good to generate boolean[] from byte[] et. cetera.

Field Summary
static int[]BITS
static intBIT_0
Mask for bit 0 of a byte.
static intBIT_1
Mask for bit 1 of a byte.
static intBIT_2
Mask for bit 2 of a byte.
static intBIT_3
Mask for bit 3 of a byte.
static intBIT_4
Mask for bit 4 of a byte.
static intBIT_5
Mask for bit 5 of a byte.
static intBIT_6
Mask for bit 6 of a byte.
static intBIT_7
Mask for bit 7 of a byte.
static byte[]EMPTY_BYTE_ARRAY
Empty byte array.
static char[]EMPTY_CHAR_ARRAY
Empty char array.
Method Summary
Objectdecode(Object ascii)
Decodes a byte array where each byte represents an ascii '0' or '1'.
byte[]decode(byte[] ascii)
Decodes a byte array where each byte represents an ascii '0' or '1'.
byte[]encode(byte[] raw)
Converts an array of raw binary data into an array of ascii 0 and 1 characters.
Objectencode(Object raw)
Converts an array of raw binary data into an array of ascii 0 and 1 chars.
static byte[]fromAscii(char[] ascii)
Decodes a byte array where each char represents an ascii '0' or '1'.
static byte[]fromAscii(byte[] ascii)
Decodes a byte array where each byte represents an ascii '0' or '1'.
static byte[]toAsciiBytes(byte[] raw)
Converts an array of raw binary data into an array of ascii 0 and 1 character bytes - each byte is a truncated char.
static char[]toAsciiChars(byte[] raw)
Converts an array of raw binary data into an array of ascii 0 and 1 characters.
static StringtoAsciiString(byte[] raw)
Converts an array of raw binary data into a String of ascii 0 and 1 characters.
byte[]toByteArray(String ascii)
Decodes a String where each char of the String represents an ascii '0' or '1'.

Field Detail

BITS

private static final int[] BITS

BIT_0

private static final int BIT_0
Mask for bit 0 of a byte.

BIT_1

private static final int BIT_1
Mask for bit 1 of a byte.

BIT_2

private static final int BIT_2
Mask for bit 2 of a byte.

BIT_3

private static final int BIT_3
Mask for bit 3 of a byte.

BIT_4

private static final int BIT_4
Mask for bit 4 of a byte.

BIT_5

private static final int BIT_5
Mask for bit 5 of a byte.

BIT_6

private static final int BIT_6
Mask for bit 6 of a byte.

BIT_7

private static final int BIT_7
Mask for bit 7 of a byte.

EMPTY_BYTE_ARRAY

private static final byte[] EMPTY_BYTE_ARRAY
Empty byte array.

EMPTY_CHAR_ARRAY

private static final char[] EMPTY_CHAR_ARRAY
Empty char array.

Method Detail

decode

public Object decode(Object ascii)
Decodes a byte array where each byte represents an ascii '0' or '1'.

Parameters: ascii each byte represents an ascii '0' or '1'

Returns: the raw encoded binary where each bit corresponds to a byte in the byte array argument

Throws: DecoderException if argument is not a byte[], char[] or String

See Also: Decoder

decode

public byte[] decode(byte[] ascii)
Decodes a byte array where each byte represents an ascii '0' or '1'.

Parameters: ascii each byte represents an ascii '0' or '1'

Returns: the raw encoded binary where each bit corresponds to a byte in the byte array argument

See Also: decode

encode

public byte[] encode(byte[] raw)
Converts an array of raw binary data into an array of ascii 0 and 1 characters.

Parameters: raw the raw binary data to convert

Returns: 0 and 1 ascii character bytes one for each bit of the argument

See Also: (byte[])

encode

public Object encode(Object raw)
Converts an array of raw binary data into an array of ascii 0 and 1 chars.

Parameters: raw the raw binary data to convert

Returns: 0 and 1 ascii character chars one for each bit of the argument

Throws: EncoderException if the argument is not a byte[]

See Also: Encoder

fromAscii

public static byte[] fromAscii(char[] ascii)
Decodes a byte array where each char represents an ascii '0' or '1'.

Parameters: ascii each char represents an ascii '0' or '1'

Returns: the raw encoded binary where each bit corresponds to a char in the char array argument

fromAscii

public static byte[] fromAscii(byte[] ascii)
Decodes a byte array where each byte represents an ascii '0' or '1'.

Parameters: ascii each byte represents an ascii '0' or '1'

Returns: the raw encoded binary where each bit corresponds to a byte in the byte array argument

toAsciiBytes

public static byte[] toAsciiBytes(byte[] raw)
Converts an array of raw binary data into an array of ascii 0 and 1 character bytes - each byte is a truncated char.

Parameters: raw the raw binary data to convert

Returns: an array of 0 and 1 character bytes for each bit of the argument

See Also: (byte[])

toAsciiChars

public static char[] toAsciiChars(byte[] raw)
Converts an array of raw binary data into an array of ascii 0 and 1 characters.

Parameters: raw the raw binary data to convert

Returns: an array of 0 and 1 characters for each bit of the argument

See Also: (byte[])

toAsciiString

public static String toAsciiString(byte[] raw)
Converts an array of raw binary data into a String of ascii 0 and 1 characters.

Parameters: raw the raw binary data to convert

Returns: a String of 0 and 1 characters representing the binary data

See Also: (byte[])

toByteArray

public byte[] toByteArray(String ascii)
Decodes a String where each char of the String represents an ascii '0' or '1'.

Parameters: ascii String of '0' and '1' characters

Returns: the raw encoded binary where each bit corresponds to a byte in the byte array argument

See Also: decode

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