org.antfarmer.ejce.encoder

Class AbstractBase32Encoder

java.lang.Object

org.antfarmer.ejce.encoder.AbstractBase32Encoder

All Implemented Interfaces:

TextEncoder

Direct Known Subclasses:

AbstractBase32NonNumericEncoder, Base32Encoder, Base32PaddedEncoder

public abstract class AbstractBase32Encoder
extends Object
implements TextEncoder

Abstract encoder for encoding/decoding bytes and text using the Base-32 format. The encoded results contain only US-ASCII letters and numbers. The character set includes: [A-Z2-7]. This format results in a 60% increase in output length at best. This class is thread-safe.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBase32Encoder() Initializes the AbstractBase32Encoder.

Method Summary

Modifier and Type	Method and Description
byte[]	decode(String text) Decodes the string into a byte array.
String	encode(byte[] bytes) Encodes the byte array to a string.
protected byte[]	getDecodeArray() Returns the decodeArray.
protected byte[]	getEncodeArray() Returns the encodeArray.
protected byte	getPaddingChar() Returns the padding character.
protected boolean	isUsePadding() Returns true if this encoder uses padding.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBase32Encoder

protected AbstractBase32Encoder()

Initializes the AbstractBase32Encoder.

Method Detail

getEncodeArray

protected final byte[] getEncodeArray()

Returns the encodeArray.

Returns:

the encodeArray

getDecodeArray

protected final byte[] getDecodeArray()

Returns the decodeArray.

Returns:

the decodeArray

getPaddingChar

protected byte getPaddingChar()

Returns the padding character.

Returns:

the padding character

isUsePadding

protected boolean isUsePadding()

Returns true if this encoder uses padding.

Returns:

true if this encoder uses padding; false otherwise

encode

public String encode(byte[] bytes)

Encodes the byte array to a string.

Specified by:

encode in interface TextEncoder

Parameters:

bytes - the byte array

Returns:

a string representation of the byte array

decode

public byte[] decode(String text)

Decodes the string into a byte array.

Specified by:

decode in interface TextEncoder

Parameters:

text - the encoded text

Returns:

the byte array represented by the encoded text