edu.msoe.jones.bitstream

Class BitInputStream

java.lang.Object

edu.msoe.jones.bitstream.BitInputStream

All Implemented Interfaces:

java.lang.AutoCloseable

public final class BitInputStream
extends java.lang.Object
implements java.lang.AutoCloseable

A file input stream that reads a byte from a binary file then returns a single integer at a time, representing a single bit as a 0 or 1.

Constructor Summary

Constructors

Constructor and Description
BitInputStream(java.io.InputStream in) Constructs a BitInputStream using the given InputStream

Method Summary

Modifier and Type	Method and Description
void	close() Closes this stream and the underlying inputStream stream.
int	read() Reads a bit from the stream.
int	readNoEof() Reads a bit from this stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

BitInputStream

public BitInputStream(java.io.InputStream in)

Constructs a BitInputStream using the given InputStream

Parameters:

in - the inputStream stream

Throws:

java.lang.NullPointerException - if the inputStream stream is null

Method Detail

read

public int read()
         throws java.io.IOException

Reads a bit from the stream. Returns 0 or 1 if a bit is available, -1 otherwise.

Returns:

the value of the next bit, -1 for the end of stream

Throws:

java.io.IOException - for read failure

readNoEof

public int readNoEof()
              throws java.io.IOException

Reads a bit from this stream. Returns 0 or 1 if a bit is available, or throws an EOFException if the end of stream is reached.

Returns:

the next bit of 0 or 1

Throws:

java.io.IOException - if an I/O exception occurred

java.io.EOFException - if the end of stream is reached

close

public void close()
           throws java.io.IOException

Closes this stream and the underlying inputStream stream.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if needed