Package eu.bandm.tools.util.files

Class BitInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

eu.bandm.tools.util.files.BitInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BitInputStream
extends FilterInputStream

Intput Stream which allows to read single bits sequentially. Bits have been written by BitOutputStream, i.e. left aligned. For details see there. Mark and reset as documented from the superclass are supported.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
BitInputStream(InputStream in)	Only constructed.

Method Summary

Modifier and Type	Method	Description
void	byteAlign()	Invalidate the bit buffer whenever a primitive type (made of whole bytes( is read.
void	mark(int readlimit)	Additionally the current state of the bit buffer and bit index are saved.
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
int	readBit()	Reads one bit value from the packed data stream.
void	reset()	Additionally the current state of the bit buffer and bit index are restored.

Methods inherited from class java.io.FilterInputStream

available, close, markSupported, skip

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

BitInputStream

public BitInputStream(InputStream in)

Only constructed. Sets the source of the read operations.

Method Details

readBit

public int readBit()
            throws IOException

Reads one bit value from the packed data stream.

Returns:

0 or 1 as a bit value or -1 when reading past end of stream.

Throws:

IOException

byteAlign

public void byteAlign()

Invalidate the bit buffer whenever a primitive type (made of whole bytes( is read.

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] b,
 int off,
 int len)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

mark

public void mark(int readlimit)

Additionally the current state of the bit buffer and bit index are saved.

Overrides:

mark in class FilterInputStream

reset

public void reset()
           throws IOException

Additionally the current state of the bit buffer and bit index are restored.

Overrides:

reset in class FilterInputStream

Throws:

IOException