org.refcodes.codec

Enum BaseCodecConfig

java.lang.Object

java.lang.Enum<BaseCodecConfig>

org.refcodes.codec.BaseCodecConfig

All Implemented Interfaces:

Serializable, Comparable<BaseCodecConfig>, BaseCodecMetrics

public enum BaseCodecConfig
extends Enum<BaseCodecConfig>
implements BaseCodecMetrics

This enumeration provided access to pre-configured BaseCodecMetrics to be used by a BaseCodecBuilder.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASE10
BASE11
BASE12
BASE13
BASE14
BASE15
BASE16
BASE17
BASE18
BASE19
BASE2
BASE20
BASE21
BASE22
BASE23
BASE24
BASE25
BASE26
BASE27
BASE28
BASE29
BASE3
BASE30
BASE31
BASE32
BASE33
BASE34
BASE35
BASE36
BASE37
BASE38
BASE39
BASE4
BASE40
BASE41
BASE42
BASE43
BASE44
BASE45
BASE46
BASE47
BASE48
BASE49
BASE5
BASE50
BASE51
BASE52
BASE53
BASE54
BASE55
BASE56
BASE57
BASE58
BASE59
BASE6
BASE60
BASE61
BASE62
BASE63
BASE64
BASE64_ARABIC
BASE64_URL
BASE7
BASE8
BASE9
BIN
DEC
HEX
OCT

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.
static BaseCodecMetrics	toBaseCodec(int aNumberBase)
char	toChar(int aValue) Retrieves the (encoded) character for the (decoded) value.
String	toString()
int	toValue(char aChar) Retrieves the (decoded) value for the (encoded) character.
static BaseCodecConfig	valueOf(String name) Returns the enum constant of this type with the specified name.
static BaseCodecConfig[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BASE2

public static final BaseCodecConfig BASE2

BIN

public static final BaseCodecConfig BIN

BASE3

public static final BaseCodecConfig BASE3

BASE4

public static final BaseCodecConfig BASE4

BASE5

public static final BaseCodecConfig BASE5

BASE6

public static final BaseCodecConfig BASE6

BASE7

public static final BaseCodecConfig BASE7

BASE8

public static final BaseCodecConfig BASE8

OCT

public static final BaseCodecConfig OCT

BASE9

public static final BaseCodecConfig BASE9

BASE10

public static final BaseCodecConfig BASE10

DEC

public static final BaseCodecConfig DEC

BASE11

public static final BaseCodecConfig BASE11

BASE12

public static final BaseCodecConfig BASE12

BASE13

public static final BaseCodecConfig BASE13

BASE14

public static final BaseCodecConfig BASE14

BASE15

public static final BaseCodecConfig BASE15

BASE16

public static final BaseCodecConfig BASE16

HEX

public static final BaseCodecConfig HEX

BASE17

public static final BaseCodecConfig BASE17

BASE18

public static final BaseCodecConfig BASE18

BASE19

public static final BaseCodecConfig BASE19

BASE20

public static final BaseCodecConfig BASE20

BASE21

public static final BaseCodecConfig BASE21

BASE22

public static final BaseCodecConfig BASE22

BASE23

public static final BaseCodecConfig BASE23

BASE24

public static final BaseCodecConfig BASE24

BASE25

public static final BaseCodecConfig BASE25

BASE26

public static final BaseCodecConfig BASE26

BASE27

public static final BaseCodecConfig BASE27

BASE28

public static final BaseCodecConfig BASE28

BASE29

public static final BaseCodecConfig BASE29

BASE30

public static final BaseCodecConfig BASE30

BASE31

public static final BaseCodecConfig BASE31

BASE32

public static final BaseCodecConfig BASE32

BASE33

public static final BaseCodecConfig BASE33

BASE34

public static final BaseCodecConfig BASE34

BASE35

public static final BaseCodecConfig BASE35

BASE36

public static final BaseCodecConfig BASE36

BASE37

public static final BaseCodecConfig BASE37

BASE38

public static final BaseCodecConfig BASE38

BASE39

public static final BaseCodecConfig BASE39

BASE40

public static final BaseCodecConfig BASE40

BASE41

public static final BaseCodecConfig BASE41

BASE42

public static final BaseCodecConfig BASE42

BASE43

public static final BaseCodecConfig BASE43

BASE44

public static final BaseCodecConfig BASE44

BASE45

public static final BaseCodecConfig BASE45

BASE46

public static final BaseCodecConfig BASE46

BASE47

public static final BaseCodecConfig BASE47

BASE48

public static final BaseCodecConfig BASE48

BASE49

public static final BaseCodecConfig BASE49

BASE50

public static final BaseCodecConfig BASE50

BASE51

public static final BaseCodecConfig BASE51

BASE52

public static final BaseCodecConfig BASE52

BASE53

public static final BaseCodecConfig BASE53

BASE54

public static final BaseCodecConfig BASE54

BASE55

public static final BaseCodecConfig BASE55

BASE56

public static final BaseCodecConfig BASE56

BASE57

public static final BaseCodecConfig BASE57

BASE58

public static final BaseCodecConfig BASE58

BASE59

public static final BaseCodecConfig BASE59

BASE60

public static final BaseCodecConfig BASE60

BASE61

public static final BaseCodecConfig BASE61

BASE62

public static final BaseCodecConfig BASE62

BASE63

public static final BaseCodecConfig BASE63

BASE64

public static final BaseCodecConfig BASE64

BASE64_ARABIC

public static final BaseCodecConfig BASE64_ARABIC

BASE64_URL

public static final BaseCodecConfig BASE64_URL

Method Detail

values

public static BaseCodecConfig[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BaseCodecConfig c : BaseCodecConfig.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BaseCodecConfig valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumberBase

public int getNumberBase()

Number base as integer.

Specified by:

getNumberBase in interface BaseCodecMetrics

getCharSet

public char[] getCharSet()

Character set to be used by the given enumeration.

Specified by:

getCharSet in interface BaseCodecMetrics

getBytesPerInt

public int getBytesPerInt()

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

Specified by:

getBytesPerInt in interface BaseCodecMetrics

getDigitsPerInt

public int getDigitsPerInt()

Number of digits stored in an integer.

Specified by:

getDigitsPerInt in interface BaseCodecMetrics

getBitsPerDigit

public int getBitsPerDigit()

Number in bits for one digit.

Specified by:

getBitsPerDigit in interface BaseCodecMetrics

getDigitsPerByte

public int getDigitsPerByte()

Number of digits required to represent a byte.

Specified by:

getDigitsPerByte in interface BaseCodecMetrics

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 BaseCodecMetrics

toBaseCodec

public static BaseCodecMetrics toBaseCodec(int aNumberBase)

toValue

public int toValue(char aChar)

Description copied from interface: BaseCodecMetrics

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

Specified by:

toValue in interface BaseCodecMetrics

toChar

public char toChar(int aValue)

Description copied from interface: BaseCodecMetrics

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

Specified by:

toChar in interface BaseCodecMetrics

toString

public String toString()

Overrides:

toString in class Enum<BaseCodecConfig>