com.github.jinahya.io.bit

Class BitInput

java.lang.Object

com.github.jinahya.io.bit.BitInput

public class BitInput
extends java.lang.Object

A class for reading arbitrary length of bits.

Author:

Jin Kwon

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteInput	input The underlying byte input.

Constructor Summary

Constructors

Constructor and Description
BitInput(ByteInput input) Creates a new instance built on top of the specified byte input.

Method Summary

Modifier and Type	Method and Description
int	align(int length) Aligns to given number of bytes.
long	getCount() Returns the number of bytes read from the underlying byte input so far.
protected boolean	isNotNull() Reads a boolean flag for nullability of the subsequent object.
protected boolean	isNull() Reads a boolean flag for nullability of the subsequent object.
static BitInput	newInstance(java.nio.ByteBuffer source) Creates a new instance consuming bytes from specified byte source.
static BitInput	newInstance(java.io.InputStream source) Creates a new instance consuming bytes from given byte source.
boolean	readBoolean() Reads a 1-bit boolean value.
protected void	readBytes(int range, byte[] value, int offset, int length) Reads a sequence of bytes.
byte[]	readBytes(int scale, int range) Reads an array of bytes.
int	readBytes(int scale, int range, byte[] value, int offset) Reads a sequence of bytes.
double	readDouble() Reads a double value.
float	readFloat() Reads a float value.
int	readInt(int length) Reads a signed int value.
long	readLong(int length) Reads a signed long value.
java.lang.String	readString(java.lang.String charsetName) Reads a string.
protected int	readUnsignedByte(int length) Reads an unsigned byte value.
int	readUnsignedInt(int length) Reads an unsigned int value.
long	readUnsignedLong(int length) Reads an unsigned long value.
protected int	readUnsignedShort(int length) Reads an unsigned short value.
java.lang.String	readUsAsciiString() Reads a US-ASCII encoded string.

Methods inherited from class java.lang.Object

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

Field Detail

input

protected final ByteInput input

The underlying byte input.

Constructor Detail

BitInput

public BitInput(ByteInput input)

Creates a new instance built on top of the specified byte input.

Parameters:

input - the byte input on which this bit input is built.

Throws:

java.lang.NullPointerException - if the specified input is null.

Method Detail

newInstance

public static BitInput newInstance(java.io.InputStream source)

Creates a new instance consuming bytes from given byte source.

Parameters:

source - the byte source

Returns:

a new instance

Throws:

java.lang.NullPointerException - if source is null.

newInstance

public static BitInput newInstance(java.nio.ByteBuffer source)

Creates a new instance consuming bytes from specified byte source.

Parameters:

source - the byte source.

Returns:

a new instance.

readUnsignedByte

protected int readUnsignedByte(int length)
                        throws java.io.IOException

Reads an unsigned byte value.

Parameters:

length - the number of bits for the value; between 0 (exclusive) and 8 (inclusive).

Returns:

an unsigned byte value.

Throws:

java.lang.IllegalArgumentException - if length is not valid.

java.io.IOException - if an I/O error occurs.

readBoolean

public boolean readBoolean()
                    throws java.io.IOException

Reads a 1-bit boolean value. true for 0b1 and false for 0b0.

Returns:

a boolean value.

Throws:

java.io.IOException - if an I/O error occurs.

isNull

protected boolean isNull()
                  throws java.io.IOException

Reads a boolean flag for nullability of the subsequent object.

Returns:

true if the subsequent object is null or false if the subsequent object is not null.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

isNotNull()

isNotNull

protected boolean isNotNull()
                     throws java.io.IOException

Reads a boolean flag for nullability of the subsequent object.

Returns:

true if the subsequent object is not null or false if the subsequent object is null.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

isNull()

readUnsignedShort

protected int readUnsignedShort(int length)
                         throws java.io.IOException

Reads an unsigned short value.

Parameters:

length - the number of bits for the value; between 0 (exclusive) and 16 (inclusive).

Returns:

the unsigned short value.

Throws:

java.lang.IllegalArgumentException - if length is not valid.

java.io.IOException - if an I/O error occurs.

readUnsignedInt

public int readUnsignedInt(int length)
                    throws java.io.IOException

Reads an unsigned int value.

Parameters:

length - the number of bits for the value; between 1 (inclusive) and 32 (exclusive).

Returns:

the unsigned int value

Throws:

java.lang.IllegalArgumentException - if length is not valid.

java.io.IOException - if an I/O error occurs

readInt

public int readInt(int length)
            throws java.io.IOException

Reads a signed int value.

Parameters:

length - the number of bits for the value; between 1 (exclusive) and 32 (inclusive).

Returns:

a signed int value.

Throws:

java.lang.IllegalArgumentException - if length is not valid.

java.io.IOException - if an I/O error occurs.

readFloat

public float readFloat()
                throws java.io.IOException

Reads a float value.

Returns:

a float value.

Throws:

java.io.IOException - if an I/O error occurs

See Also:

Float.intBitsToFloat(int)

readUnsignedLong

public long readUnsignedLong(int length)
                      throws java.io.IOException

Reads an unsigned long value.

Parameters:

length - the number of bits for the value; between 1 (inclusive) and 64 (exclusive).

Returns:

an unsigned long value.

Throws:

java.lang.IllegalArgumentException - if length is not valid

java.io.IOException - if an I/O error occurs

readLong

public long readLong(int length)
              throws java.io.IOException

Reads a signed long value.

Parameters:

length - the number of bits for the value; between 1 (exclusive) and 64 (inclusive).

Returns:

a signed long value

Throws:

java.lang.IllegalArgumentException - if length is not valid

java.io.IOException - if an I/O error occurs.

readDouble

public final double readDouble()
                        throws java.io.IOException

Reads a double value.

Returns:

a double value

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

Double.longBitsToDouble(long)

readBytes

protected void readBytes(int range,
                         byte[] value,
                         int offset,
                         int length)
                  throws java.io.IOException

Reads a sequence of bytes.

Parameters:

range - the number of valid bits in each byte; between 0 (exclusive) and 8 (inclusive).

value - the array to which each byte are stored.

offset - starting offset in the array.

length - the number of bytes to read

Throws:

java.io.IOException - if an I/O error occurs.

readBytes

public int readBytes(int scale,
                     int range,
                     byte[] value,
                     int offset)
              throws java.io.IOException

Reads a sequence of bytes.

Parameters:

scale - the number of bits required for calculating the number of bytes to read; between 0 (exclusive) and 16 (inclusive).

range - the number of valid bits in each byte; between 0 (exclusive) and 8 (inclusive).

value - the array to which each byte are stored

offset - starting offset in the array

Returns:

the number of bytes read which is readUnsignedShort(scale)

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

readBytes(int, byte[], int, int)

readBytes

public byte[] readBytes(int scale,
                        int range)
                 throws java.io.IOException

Reads an array of bytes.

Parameters:

scale - the number of bits for calculating the number of bytes to read; between 0 (exclusive) and 16 (inclusive).

range - the number of valid bits in each byte; between 0 (exclusive) and 8 (inclusive).

Returns:

an array of bytes.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

readBytes(int, byte[], int, int)

readString

public java.lang.String readString(java.lang.String charsetName)
                            throws java.io.IOException

Reads a string. This method reads a byte array via readBytes(int, int) with scale of 16 and range of 8 and returns the output string created by String.String(byte[], java.lang.String) with the byte array and given charsetName.

Parameters:

charsetName - the character set name to encode output string.

Returns:

a string value.

Throws:

java.lang.NullPointerException - if charsetName is null.

java.io.IOException - if an I/O error occurs.

See Also:

readBytes(int, int), String.String(byte[], java.lang.String)

readUsAsciiString

public java.lang.String readUsAsciiString()
                                   throws java.io.IOException

Reads a US-ASCII encoded string. This method reads a byte array via readBytes(int, int) with scale of 16 and range of 7 and returns the output string created by String.String(byte[], java.lang.String) with the byte array and US-ASCII.

Returns:

a US-ASCII encoded string.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

readBytes(int, int), String.String(byte[], java.lang.String)

align

public int align(int length)
          throws java.io.IOException

Aligns to given number of bytes.

Parameters:

length - the number of bytes to align; between 0 (exclusive) and 32767 (inclusive).

Returns:

the number of bits discarded for alignment

Throws:

java.lang.IllegalArgumentException - if length is not valid.

java.io.IOException - if an I/O error occurs.

getCount

public long getCount()

Returns the number of bytes read from the underlying byte input so far.

Returns:

the number of bytes read so far.