org.cryptacular.codec

Class Base64Encoder

java.lang.Object

org.cryptacular.codec.AbstractBaseNEncoder

org.cryptacular.codec.Base64Encoder

All Implemented Interfaces:

Encoder

public class Base64Encoder
extends AbstractBaseNEncoder

Stateful base 64 encoder with support for configurable line breaks.

Author:

Middleware Services

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Base64Encoder.Builder Builder for base-64 encoders.

Field Summary

Fields inherited from class org.cryptacular.codec.AbstractBaseNEncoder

lineLength

Constructor Summary

Constructors

Constructor and Description
Base64Encoder() Creates a new instance that produces base 64-encoded output with no line breaks in the default character set.
Base64Encoder(boolean urlSafe) Creates a new instance that produces base 64-encoded output with no line breaks and optional URL-safe character set.
Base64Encoder(boolean urlSafe, int charactersPerLine) Creates a new instance that produces base 64-encoded output with the given number of characters per line with the option of URL-safe character set.
Base64Encoder(int charactersPerLine) Creates a new instance that produces base 64-encoded output with the given number of characters per line in the default character set.
Base64Encoder(String alphabet) Creates a new instance that produces base 64-encoded output with the given 64-character alphabet.
Base64Encoder(String alphabet, int charactersPerLine) Creates a new instance that produces base 64-encoded output with the given 64-character alphabet with line wrapping at the specified line length;

Method Summary

Modifier and Type	Method and Description
protected int	getBitsPerChar()
protected int	getBlockLength()

Methods inherited from class org.cryptacular.codec.AbstractBaseNEncoder

encode, encodingTable, finalize, isPaddedOutput, outputSize, setPaddedOutput

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64Encoder

public Base64Encoder()

Creates a new instance that produces base 64-encoded output with no line breaks in the default character set.

Base64Encoder

public Base64Encoder(boolean urlSafe)

Creates a new instance that produces base 64-encoded output with no line breaks and optional URL-safe character set.

Parameters:

urlSafe - True to use URL and filesystem-safe character set, false otherwise.

Base64Encoder

public Base64Encoder(int charactersPerLine)

Creates a new instance that produces base 64-encoded output with the given number of characters per line in the default character set.

Parameters:

charactersPerLine - Number of characters per line. A zero or negative value disables line breaks.

Base64Encoder

public Base64Encoder(boolean urlSafe,
                     int charactersPerLine)

Creates a new instance that produces base 64-encoded output with the given number of characters per line with the option of URL-safe character set.

Parameters:

urlSafe - True to use URL and filesystem-safe character set, false otherwise.

charactersPerLine - Number of characters per line. A zero or negative value disables line breaks.

Base64Encoder

public Base64Encoder(String alphabet)

Creates a new instance that produces base 64-encoded output with the given 64-character alphabet.

Parameters:

alphabet - 64-character alphabet to use.

Base64Encoder

public Base64Encoder(String alphabet,
                     int charactersPerLine)

Creates a new instance that produces base 64-encoded output with the given 64-character alphabet with line wrapping at the specified line length;

Parameters:

alphabet - 64-character alphabet to use.

charactersPerLine - Number of characters per line. A zero or negative value disables line breaks.

Method Detail

getBlockLength

protected int getBlockLength()

Specified by:

getBlockLength in class AbstractBaseNEncoder

Returns:

Number of bits in a block of encoded characters.

getBitsPerChar

protected int getBitsPerChar()

Specified by:

getBitsPerChar in class AbstractBaseNEncoder

Returns:

Number of bits encoding a single character.