com.ziesemer.utils.codec.impl

Class Base64Encoder

java.lang.Object

com.ziesemer.utils.codec.base.BaseCoder<ByteBuffer,CharBuffer,T>

com.ziesemer.utils.codec.base.ByteToCharEncoder<Base64Encoder>

com.ziesemer.utils.codec.impl.Base64Encoder

All Implemented Interfaces:

IByteToCharEncoder, ICoder<ByteBuffer,CharBuffer>, Serializable, Cloneable

public class Base64Encoder
extends ByteToCharEncoder<Base64Encoder>

Encodes to "Base64 encoding", as specified by http://tools.ietf.org/html/rfc4648#section-4.

Author:

Mark A. Ziesemer <www.ziesemer.com>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected char[]	byteToCharList
protected static float	CORE_CHARS_PER_BYTE
static String	DEFAULT_SECTION_SEPARATOR
protected int	minOutFree
protected String	sectionSeparator
protected int	separatorFreq
protected long	sepCharsWritten

Fields inherited from class com.ziesemer.utils.codec.base.BaseCoder

averageOutPerIn, maxOutPerIn, minInPerOut, state

Constructor Summary

Constructors

Constructor and Description
Base64Encoder()

Method Summary

Modifier and Type	Method and Description
protected void	addSectionSeparator(CharBuffer out)
protected CoderResult	codingLoop(ByteBuffer in, CharBuffer out, boolean endOfInput)
protected void	configImpl(Base64Encoder base) Hook for implementations to configure themselves from another instance.
char[]	getByteToCharList()
String	getSectionSeparator()
int	getSeparatorFreq()
protected void	init() Hook called once after the first coding operation is started.
protected void	resetImpl() Hook called from BaseCoder.reset().
Base64Encoder	setByteToCharList(char[] byteToCharList)
Base64Encoder	setSectionSeparator(String sectionSeparator)
Base64Encoder	setSeparatorFreq(int separatorFreq)

Methods inherited from class com.ziesemer.utils.codec.base.ByteToCharEncoder

allocate, encodeToString, put

Methods inherited from class com.ziesemer.utils.codec.base.BaseCoder

checkConfigAllowed, checkNullArgument, clone, code, code, config, flush, getAverageOutPerIn, getMaxOutPerIn, getMinInPerOut, implFlush, reset, throwIllegalStateException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ziesemer.utils.codec.ICoder

clone, code, code, config, flush, getAverageOutPerIn, getMaxOutPerIn, getMinInPerOut, reset

Field Detail

DEFAULT_SECTION_SEPARATOR

public static final String DEFAULT_SECTION_SEPARATOR

See Also:

Constant Field Values

CORE_CHARS_PER_BYTE

protected static final float CORE_CHARS_PER_BYTE

See Also:

Constant Field Values

byteToCharList

protected char[] byteToCharList

sectionSeparator

protected String sectionSeparator

separatorFreq

protected int separatorFreq

sepCharsWritten

protected transient long sepCharsWritten

minOutFree

protected transient int minOutFree

Constructor Detail

Base64Encoder

public Base64Encoder()

Method Detail

configImpl

protected void configImpl(Base64Encoder base)

Description copied from class: BaseCoder

Hook for implementations to configure themselves from another instance. The base implementation does nothing.

Overrides:

configImpl in class BaseCoder<ByteBuffer,CharBuffer,Base64Encoder>

Parameters:

base - The instance to copy the configuration from.

init

protected void init()

Description copied from class: BaseCoder

Hook called once after the first coding operation is started. The base implementation does nothing.

Overrides:

init in class BaseCoder<ByteBuffer,CharBuffer,Base64Encoder>

getByteToCharList

public char[] getByteToCharList()

setByteToCharList

public Base64Encoder setByteToCharList(char[] byteToCharList)

getSectionSeparator

public String getSectionSeparator()

setSectionSeparator

public Base64Encoder setSectionSeparator(String sectionSeparator)

getSeparatorFreq

public int getSeparatorFreq()

setSeparatorFreq

public Base64Encoder setSeparatorFreq(int separatorFreq)

codingLoop

protected CoderResult codingLoop(ByteBuffer in,
                                 CharBuffer out,
                                 boolean endOfInput)

Specified by:

codingLoop in class BaseCoder<ByteBuffer,CharBuffer,Base64Encoder>

addSectionSeparator

protected void addSectionSeparator(CharBuffer out)

resetImpl

protected void resetImpl()

Description copied from class: BaseCoder

Hook called from BaseCoder.reset(). The base implementation does nothing.

Overrides:

resetImpl in class BaseCoder<ByteBuffer,CharBuffer,Base64Encoder>