public class

BinaryCodec

extends Object
implements BinaryDecoder BinaryEncoder
java.lang.Object
   ↳ org.apache.commons.codec.binary.BinaryCodec

Class Overview

Translates between byte arrays and strings of "0"s and "1"s. TODO: may want to add more bit vector functions like and/or/xor/nand TODO: also might be good to generate boolean[] from byte[] et. cetera.

Summary

Public Constructors
BinaryCodec()
Public Methods
byte[] decode(byte[] ascii)
Decodes a byte array where each byte represents an ASCII '0' or '1'.
Object decode(Object 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.
Object encode(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 char 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 String toAsciiString(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'.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.commons.codec.BinaryDecoder
From interface org.apache.commons.codec.BinaryEncoder
From interface org.apache.commons.codec.Decoder
From interface org.apache.commons.codec.Encoder

Public Constructors

public BinaryCodec ()

Public Methods

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

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

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

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

public static byte[] fromAscii (char[] ascii)

Decodes a char 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

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

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

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

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

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