com.ziesemer.utils.codec.impl

Class HexEncoder

java.lang.Object

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

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

com.ziesemer.utils.codec.impl.HexEncoder

All Implemented Interfaces:

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

public class HexEncoder
extends ByteToCharEncoder<HexEncoder>

Encodes to "hexadecimal encoding", where each byte is represented by 2 characters (0-padded if necessary).

Can be configured to encode using a specific character list. This is designed only for choosing between the HexUpperCharList (default) and HexLowerCharList, as the HexDecoder currently does not offer a reciprocal configuration option and can only decode from the standard format used by these lists.

Author:

Mark A. Ziesemer <www.ziesemer.com>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected char[]	byteToCharList
static String	DEFAULT_SECTION_SEPARATOR
protected String	sectionSeparator
protected int	separatorFreq
protected long	sepBytesWritten

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

averageOutPerIn, maxOutPerIn, minInPerOut, state

Constructor Summary

Constructors

Constructor and Description
HexEncoder()

Method Summary

Modifier and Type	Method and Description
protected CoderResult	codingLoop(ByteBuffer in, CharBuffer out, boolean endOfInput)
protected void	configImpl(HexEncoder 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().
HexEncoder	setByteToCharList(char[] byteToCharList)
HexEncoder	setSectionSeparator(String sectionSeparator)
HexEncoder	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

byteToCharList

protected char[] byteToCharList

sectionSeparator

protected String sectionSeparator

separatorFreq

protected int separatorFreq

sepBytesWritten

protected transient long sepBytesWritten

Constructor Detail

HexEncoder

public HexEncoder()

Method Detail

configImpl

protected void configImpl(HexEncoder 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,HexEncoder>

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,HexEncoder>

getByteToCharList

public char[] getByteToCharList()

setByteToCharList

public HexEncoder setByteToCharList(char[] byteToCharList)

getSectionSeparator

public String getSectionSeparator()

setSectionSeparator

public HexEncoder setSectionSeparator(String sectionSeparator)

getSeparatorFreq

public int getSeparatorFreq()

setSeparatorFreq

public HexEncoder setSeparatorFreq(int separatorFreq)

codingLoop

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

Specified by:

codingLoop in class BaseCoder<ByteBuffer,CharBuffer,HexEncoder>

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,HexEncoder>