Package com.igormaznitsa.jbbp.io

Enum Class JBBPBitNumber

java.lang.Object

java.lang.Enum<JBBPBitNumber>

com.igormaznitsa.jbbp.io.JBBPBitNumber

All Implemented Interfaces:

Serializable, Comparable<JBBPBitNumber>, Constable

public enum JBBPBitNumber
extends Enum<JBBPBitNumber>

Constants allowed bit numbers for bit operations.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BITS_1	One bit.
BITS_2	Two bits.
BITS_3	Three bits.
BITS_4	Four bits.
BITS_5	Five bits.
BITS_6	Six bits.
BITS_7	Seven bits.
BITS_8	Eight bits.

Method Summary

Modifier and Type	Method	Description
static JBBPBitNumber	decode(int numberOfBits)	Decode a numeric value to a constant.
int	getBitNumber()	Get the numeric value of the bit number.
int	getMask()	Get the mask for the number of bits.
static JBBPBitNumber	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JBBPBitNumber[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BITS_1

public static final JBBPBitNumber BITS_1

One bit.

BITS_2

public static final JBBPBitNumber BITS_2

Two bits.

BITS_3

public static final JBBPBitNumber BITS_3

Three bits.

BITS_4

public static final JBBPBitNumber BITS_4

Four bits.

BITS_5

public static final JBBPBitNumber BITS_5

Five bits.

BITS_6

public static final JBBPBitNumber BITS_6

Six bits.

BITS_7

public static final JBBPBitNumber BITS_7

Seven bits.

BITS_8

public static final JBBPBitNumber BITS_8

Eight bits.

Method Details

values

public static JBBPBitNumber[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static JBBPBitNumber valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

decode

public static JBBPBitNumber decode(int numberOfBits)

Decode a numeric value to a constant.

Parameters:

numberOfBits - the numeric value to be decoded

Returns:

decoded constant

Throws:

IllegalArgumentException - if the value less than 1 or greater than 8

getMask

public int getMask()

Get the mask for the number of bits.

Returns:

the mask for the number of bits

getBitNumber

public int getBitNumber()

Get the numeric value of the bit number.

Returns:

the number of bits as integer