org.refcodes.codec

Interface BaseCodecMetrics

All Superinterfaces:

org.refcodes.mixin.CharSetAccessor, org.refcodes.numerical.PaddingCharAccessor

All Known Implementing Classes:

BaseCodecConfig, BaseCodecMetricsImpl

public interface BaseCodecMetrics
extends org.refcodes.mixin.CharSetAccessor, org.refcodes.numerical.PaddingCharAccessor

Provides the metrics for a codec to be used by an implementation of the BaseCodecBuilder.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.CharSetAccessor

org.refcodes.mixin.CharSetAccessor.CharSetBuilder<B extends org.refcodes.mixin.CharSetAccessor.CharSetBuilder<B>>, org.refcodes.mixin.CharSetAccessor.CharSetMutator, org.refcodes.mixin.CharSetAccessor.CharSetProperty

Nested classes/interfaces inherited from interface org.refcodes.numerical.PaddingCharAccessor

org.refcodes.numerical.PaddingCharAccessor.PaddingCharBuilder<B extends org.refcodes.numerical.PaddingCharAccessor.PaddingCharBuilder<B>>, org.refcodes.numerical.PaddingCharAccessor.PaddingCharMutator, org.refcodes.numerical.PaddingCharAccessor.PaddingCharProperty

Method Summary

Modifier and Type	Method and Description
int	getBitsPerDigit() Number in bits for one digit.
int	getBytesPerInt() Number of bytes to exactly store a minimum number of digits.
char[]	getCharSet() Character set to be used by the given enumeration.
int	getDigitMask() The digit mask is the bit-field covering just the digit's bits (starting at bit 0).
int	getDigitsPerByte() Number of digits required to represent a byte.
int	getDigitsPerInt() Number of digits stored in an integer.
int	getNumberBase() Number base as integer.
char	toChar(int aValue) Retrieves the (encoded) character for the (decoded) value.
int	toValue(char aChar) Retrieves the (decoded) value for the (encoded) character.

Methods inherited from interface org.refcodes.numerical.PaddingCharAccessor

getPaddingChar

Method Detail

getNumberBase

int getNumberBase()

Number base as integer.

getCharSet

char[] getCharSet()

Character set to be used by the given enumeration.

Specified by:

getCharSet in interface org.refcodes.mixin.CharSetAccessor

getBytesPerInt

int getBytesPerInt()

Number of bytes to exactly store a minimum number of digits.

getDigitsPerInt

int getDigitsPerInt()

Number of digits stored in an integer.

getBitsPerDigit

int getBitsPerDigit()

Number in bits for one digit.

getDigitsPerByte

int getDigitsPerByte()

Number of digits required to represent a byte.

getDigitMask

int getDigitMask()

The digit mask is the bit-field covering just the digit's bits (starting at bit 0). Those bits in the mask are set to one which are required to represent a digit.

toValue

int toValue(char aChar)

Retrieves the (decoded) value for the (encoded) character.

toChar

char toChar(int aValue)

Retrieves the (encoded) character for the (decoded) value.