Module com.github.jinahya.bit.io

Package com.github.jinahya.bit.io

Class BitInputAdapter

java.lang.Object

com.github.jinahya.bit.io.BitInputAdapter

All Implemented Interfaces:

BitInput, Closeable, AutoCloseable

public class BitInputAdapter
extends Object
implements BitInput

An implementation of BitInput adapts an instance of ByteInput.

Author:

Jin Kwon <onacit_at_gmail.com>

See Also:

BitOutputAdapter

Constructor Summary

Constructors

Constructor	Description
BitInputAdapter(Supplier<? extends ByteInput> inputSupplier)	Creates a new instance with specified input supplier.

Method Summary

Modifier and Type	Method	Description
long	align(int bytes)	Aligns to specified number of bytes by discarding bits.
void	close()	Closes this input and releases any system resources associated with it.
int	readInt(boolean unsigned, int size)	Reads an int value of specified number of bits.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.jinahya.bit.io.BitInput

align, readBoolean, readByte, readByte, readByte8, readChar, readChar16, readDouble64, readFloat32, readInt, readInt32, readInt32Le, readLong, readLong, readLong64, readLong64Le, readShort, readShort, readShort16, readShort16Le, readUnsignedByte, readUnsignedInt, readUnsignedLong, readUnsignedShort, readValue, skip

Constructor Detail

BitInputAdapter

public BitInputAdapter(Supplier<? extends ByteInput> inputSupplier)

Creates a new instance with specified input supplier.

Parameters:

inputSupplier - the input supplier.

Method Detail

close

public void close()
           throws IOException

Closes this input and releases any system resources associated with it.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BitInput

Specified by:

close in interface Closeable

Throws:

IOException - if an I/O error occurs.

See Also:

ByteInput.close()

readInt

public int readInt(boolean unsigned,
                   int size)
            throws IOException

Description copied from interface: BitInput

Reads an int value of specified number of bits.

Specified by:

readInt in interface BitInput

Parameters:

unsigned - a flag for indicating unsigned value; true for unsigned, false for signed.

size - the number of bits to read; between 1 and (32 - ( unsigned ? 1: 0)), both inclusive.

Returns:

an int value of specified size.

Throws:

IOException - if an I/O error occurs.

align

public long align(int bytes)
           throws IOException

Description copied from interface: BitInput

Aligns to specified number of bytes by discarding bits.

Specified by:

align in interface BitInput

Parameters:

bytes - the number of bytes to align; must be positive.

Returns:

the number of bits discarded while aligning.

Throws:

IOException - if an I/O error occurs.