org.refcodes.codec.impls

Class BaseMetricsImpl

java.lang.Object

org.refcodes.codec.impls.BaseMetricsImpl

All Implemented Interfaces:

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

public class BaseMetricsImpl
extends Object
implements BaseMetrics

BaseMetrics implementation for playing around with your own configuration. You may use a template as one provided by BaseConfig and tweak some attributes as you wish.

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

Constructor Summary

Constructors

Constructor and Description
BaseMetricsImpl(BaseMetrics aBaseMetrics)
BaseMetricsImpl(int aNumberBase)
BaseMetricsImpl(int aNumberBase, char[] aCharSet)
BaseMetricsImpl(int aNumberBase, char[] aCharSet, char aPaddingChar)
BaseMetricsImpl(int aNumberBase, int aBitsPerDigit, int aDigitsPerByte, int aDigitsPerInt, int aBytesPerInt, char[] aCharSet)
BaseMetricsImpl(int aNumberBase, int aBitsPerDigit, int aDigitsPerByte, int aDigitsPerInt, int aBytesPerInt, char[] aCharSet, char aPaddingChar)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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	getPaddingChar()
int	hashCode()
protected static int	toBitsPerDigit(int aNumberBase)
protected static int	toBytesPerInt(int aBitsPerDigit)
char	toChar(int aValue) Retrieves the (encoded) character for the (decoded) value.
protected static int	toDigitMask(int aBitsPerDigit)
protected static int	toDigitsPerByte(int aNumberBase)
protected static int	toDigitsPerInt(int aBytesPerInt, int aBitsPerDigit)
String	toString()
int	toValue(char aChar) Retrieves the (decoded) value for the (encoded) character.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseMetricsImpl

public BaseMetricsImpl(int aNumberBase)

BaseMetricsImpl

public BaseMetricsImpl(int aNumberBase,
                       char[] aCharSet)

BaseMetricsImpl

public BaseMetricsImpl(int aNumberBase,
                       char[] aCharSet,
                       char aPaddingChar)

BaseMetricsImpl

public BaseMetricsImpl(int aNumberBase,
                       int aBitsPerDigit,
                       int aDigitsPerByte,
                       int aDigitsPerInt,
                       int aBytesPerInt,
                       char[] aCharSet)

BaseMetricsImpl

public BaseMetricsImpl(int aNumberBase,
                       int aBitsPerDigit,
                       int aDigitsPerByte,
                       int aDigitsPerInt,
                       int aBytesPerInt,
                       char[] aCharSet,
                       char aPaddingChar)

BaseMetricsImpl

public BaseMetricsImpl(BaseMetrics aBaseMetrics)

Method Detail

getNumberBase

public int getNumberBase()

Number base as integer.

Specified by:

getNumberBase in interface BaseMetrics

getCharSet

public char[] getCharSet()

Character set to be used by the given enumeration.

Specified by:

getCharSet in interface BaseMetrics

Specified by:

getCharSet in interface org.refcodes.mixin.CharSetAccessor

getBytesPerInt

public int getBytesPerInt()

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

Specified by:

getBytesPerInt in interface BaseMetrics

getDigitsPerInt

public int getDigitsPerInt()

Number of digits stored in an integer.

Specified by:

getDigitsPerInt in interface BaseMetrics

getBitsPerDigit

public int getBitsPerDigit()

Number in bits for one digit.

Specified by:

getBitsPerDigit in interface BaseMetrics

getDigitsPerByte

public int getDigitsPerByte()

Number of digits required to represent a byte.

Specified by:

getDigitsPerByte in interface BaseMetrics

getDigitMask

public 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.

Specified by:

getDigitMask in interface BaseMetrics

toValue

public int toValue(char aChar)

Description copied from interface: BaseMetrics

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

Specified by:

toValue in interface BaseMetrics

toChar

public char toChar(int aValue)

Description copied from interface: BaseMetrics

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

Specified by:

toChar in interface BaseMetrics

getPaddingChar

public char getPaddingChar()

Specified by:

getPaddingChar in interface org.refcodes.numerical.PaddingCharAccessor

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toDigitMask

protected static int toDigitMask(int aBitsPerDigit)

toBitsPerDigit

protected static int toBitsPerDigit(int aNumberBase)

toDigitsPerInt

protected static int toDigitsPerInt(int aBytesPerInt,
                                    int aBitsPerDigit)

toDigitsPerByte

protected static int toDigitsPerByte(int aNumberBase)

toBytesPerInt

protected static int toBytesPerInt(int aBitsPerDigit)