Package com.helger.commons.io.stream

Class BitInputStream

java.lang.Object

com.helger.commons.io.stream.NonBlockingBitInputStream

com.helger.commons.io.stream.BitInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BitInputStream
extends NonBlockingBitInputStream

The BitInputStream allows reading individual bits from a general Java InputStream. Like the various Stream-classes from Java, the BitInputStream has to be created based on another Input stream. It provides a function to read the next bit from the stream, as well as to read multiple bits at once and write the resulting data into an integer value.
For a non-blocking version see NonBlockingBitInputStream.

Author:

Andreas Jakl, Philip Helger

Constructor Summary

Constructors

Constructor	Description
BitInputStream(InputStream aIS, ByteOrder aByteOrder)	Create a new bit input stream based on an existing Java InputStream.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the underlying input stream.
int	readBit()	Read the next bit from the stream.

Methods inherited from class com.helger.commons.io.stream.NonBlockingBitInputStream

getByteOrder, readBits, toString

Methods inherited from class java.lang.Object

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

Constructor Details

BitInputStream

public BitInputStream(@Nonnull
 InputStream aIS,
 @Nonnull
 ByteOrder aByteOrder)

Create a new bit input stream based on an existing Java InputStream.

Parameters:

aIS - the input stream this class should read the bits from. May not be null.

aByteOrder - The non-null byte order to use.

Method Details

readBit

public int readBit()
            throws IOException

Read the next bit from the stream.

Overrides:

readBit in class NonBlockingBitInputStream

Returns:

0 if the bit is 0, 1 if the bit is 1.

Throws:

IOException - In case EOF is reached

close

public void close()

Close the underlying input stream.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class NonBlockingBitInputStream