com.ziesemer.utils.codec.base

Class BaseCoder<IN extends Buffer,OUT extends Buffer,T extends BaseCoder<IN,OUT,T>>

java.lang.Object

com.ziesemer.utils.codec.base.BaseCoder<IN,OUT,T>

Type Parameters:

IN - The type of Buffer being read from.

OUT - The type of Buffer being written to.

T - The concrete type that is extending this class. Used to provide automatic covariant return types for config(ICoder), clone(), and reset().

All Implemented Interfaces:

ICoder<IN,OUT>, Serializable, Cloneable

Direct Known Subclasses:

ByteToCharEncoder, CharToByteDecoder

public abstract class BaseCoder<IN extends Buffer,OUT extends Buffer,T extends BaseCoder<IN,OUT,T>>
extends Object
implements ICoder<IN,OUT>

Author:

Mark A. Ziesemer <www.ziesemer.com>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected float	averageOutPerIn
protected float	maxOutPerIn
protected float	minInPerOut
protected CodingStates	state

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseCoder(float minInPerOut, float averageOutPerIn, float maxOutPerIn)

Method Summary

Modifier and Type	Method and Description
protected abstract OUT	allocate(int capacity)
protected void	checkConfigAllowed()
protected <TA> TA	checkNullArgument(TA o)
T	clone() Another means for obtaining a configured instance copy from another.
OUT	code(IN in) Convenience method that encodes the passed-in input Buffer to a returned output Buffer.
CoderResult	code(IN in, OUT out, boolean endOfInput) Encodes as many units as possible from the given input buffer, writing the results to the given output buffer.
protected abstract CoderResult	codingLoop(IN in, OUT out, boolean endOfInput)
T	config(ICoder<IN,OUT> base) Configures this instances based upon another.
protected void	configImpl(T base) Hook for implementations to configure themselves from another instance.
CoderResult	flush(OUT out) Writes any final output after the entire input has been processed.
float	getAverageOutPerIn() Heuristic value of the average number of output units generated per input unit.
float	getMaxOutPerIn() Heuristic value of the maximum number of output units generated per input unit.
float	getMinInPerOut() Heuristic value of the minimum number of input units required to produce one or more output units.
protected CoderResult	implFlush(OUT out)
protected void	init() Hook called once after the first coding operation is started.
protected abstract OUT	put(OUT base, OUT put)
T	reset() Resets the coder, allowing it to be reused against new input and output, while keeping the same configuration.
protected void	resetImpl() Hook called from reset().
protected void	throwIllegalStateException(CodingStates from, CodingStates to)

Methods inherited from class java.lang.Object

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

Field Detail

minInPerOut

protected float minInPerOut

averageOutPerIn

protected float averageOutPerIn

maxOutPerIn

protected float maxOutPerIn

state

protected transient CodingStates state

Constructor Detail

BaseCoder

protected BaseCoder(float minInPerOut,
                    float averageOutPerIn,
                    float maxOutPerIn)

Method Detail

config

public T config(ICoder<IN,OUT> base)

Description copied from interface: ICoder

Configures this instances based upon another. The passed-in parameter must be an instance of the current implementation, or an IllegalArgumentException will be thrown.

Specified by:

config in interface ICoder<IN extends Buffer,OUT extends Buffer>

Parameters:

base - The instance to copy the configuration from.

Returns:

The current instance, supporting the builder pattern.

configImpl

protected void configImpl(T base)

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

Parameters:

base - The instance to copy the configuration from.

clone

public T clone()
        throws CloneNotSupportedException

Description copied from interface: ICoder

Another means for obtaining a configured instance copy from another. Typically utilizes ICoder.config(ICoder).

Specified by:

clone in interface ICoder<IN extends Buffer,OUT extends Buffer>

Overrides:

clone in class Object

Returns:

A copy of the current instance with the same configuration.

Throws:

CloneNotSupportedException

init

protected void init()

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

checkNullArgument

protected <TA> TA checkNullArgument(TA o)

getMinInPerOut

public float getMinInPerOut()

Description copied from interface: ICoder

Heuristic value of the minimum number of input units required to produce one or more output units.

Similar to ICoder.getAverageOutPerIn() and ICoder.getMaxOutPerIn().

Specified by:

getMinInPerOut in interface ICoder<IN extends Buffer,OUT extends Buffer>

getAverageOutPerIn

public float getAverageOutPerIn()

Description copied from interface: ICoder

Heuristic value of the average number of output units generated per input unit.

Similar to CharsetEncoder.averageBytesPerChar() and CharsetDecoder.averageCharsPerByte().

Specified by:

getAverageOutPerIn in interface ICoder<IN extends Buffer,OUT extends Buffer>

getMaxOutPerIn

public float getMaxOutPerIn()

Description copied from interface: ICoder

Heuristic value of the maximum number of output units generated per input unit.

Similar to CharsetEncoder.maxBytesPerChar() and CharsetDecoder.maxCharsPerByte().

Specified by:

getMaxOutPerIn in interface ICoder<IN extends Buffer,OUT extends Buffer>

reset

public T reset()

Description copied from interface: ICoder

Resets the coder, allowing it to be reused against new input and output, while keeping the same configuration.

Specified by:

reset in interface ICoder<IN extends Buffer,OUT extends Buffer>

resetImpl

protected void resetImpl()

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

code

public OUT code(IN in)
         throws CharacterCodingException

Description copied from interface: ICoder

Convenience method that encodes the passed-in input Buffer to a returned output Buffer.

Functions similar to CharsetEncoder.encode(java.nio.CharBuffer) and CharsetDecoder.decode(java.nio.ByteBuffer).

Specified by:

code in interface ICoder<IN extends Buffer,OUT extends Buffer>

Parameters:

in - The input Buffer to read from.

Returns:

The output Buffer written to.

Throws:

CharacterCodingException

allocate

protected abstract OUT allocate(int capacity)

put

protected abstract OUT put(OUT base,
                           OUT put)

code

public CoderResult code(IN in,
                        OUT out,
                        boolean endOfInput)

Description copied from interface: ICoder

Encodes as many units as possible from the given input buffer, writing the results to the given output buffer.

Functions similar to CharsetEncoder.encode(java.nio.CharBuffer, java.nio.ByteBuffer, boolean) and CharsetDecoder.decode(java.nio.ByteBuffer, java.nio.CharBuffer, boolean).

Specified by:

code in interface ICoder<IN extends Buffer,OUT extends Buffer>

Parameters:

in - The input Buffer to read from.

out - The output Buffer to write to.

endOfInput - true if, and only if, the invoker can provide no additional input characters beyond those in the given buffer.

codingLoop

protected abstract CoderResult codingLoop(IN in,
                                          OUT out,
                                          boolean endOfInput)

flush

public CoderResult flush(OUT out)

Description copied from interface: ICoder

Writes any final output after the entire input has been processed. Should be called after ICoder.code(Buffer, Buffer, boolean) is called for the final time.

Functions similar to CharsetEncoder.flush(java.nio.ByteBuffer) and CharsetDecoder.flush(java.nio.CharBuffer).

Specified by:

flush in interface ICoder<IN extends Buffer,OUT extends Buffer>

Parameters:

out - The output Buffer to write to.

implFlush

protected CoderResult implFlush(OUT out)

See Also:

CharsetEncoder.implFlush(java.nio.ByteBuffer), CharsetDecoder.implFlush(java.nio.CharBuffer)

checkConfigAllowed

protected void checkConfigAllowed()

throwIllegalStateException

protected void throwIllegalStateException(CodingStates from,
                                          CodingStates to)