maspack.util

Class BitInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

maspack.util.BitInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class BitInputStream
extends java.io.FilterInputStream

Read a sequence of bits from a stream

Constructor Summary

Constructors

Constructor and Description
BitInputStream(java.io.InputStream in)
BitInputStream(java.io.InputStream in, boolean littleEndian)

Method Summary

Modifier and Type	Method and Description
int	available() Returns an estimate of the number of bits that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
int	getBitCount() The number of bits read
boolean	isLittleEndian()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b) Reads up to 8*b.length bits of data from this input stream into an array of bytes.
int	read(byte[] b, int off, int len) Reads up to len bits of data from this input stream into an array of bytes.
int	readBits(int nbits) Read up to 32 bits of data
void	reset()
void	setLittleEndian(boolean littleEndian)
long	skip(long n)

Methods inherited from class java.io.FilterInputStream

close

Methods inherited from class java.lang.Object

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

Constructor Detail

BitInputStream

public BitInputStream(java.io.InputStream in)

BitInputStream

public BitInputStream(java.io.InputStream in,
                      boolean littleEndian)

Method Detail

setLittleEndian

public void setLittleEndian(boolean littleEndian)

isLittleEndian

public boolean isLittleEndian()

getBitCount

public int getBitCount()

The number of bits read

readBits

public int readBits(int nbits)
             throws java.io.IOException

Read up to 32 bits of data

Parameters:

nbits - number of bits to read

Returns:

integer containg bit values

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

read

public int read(byte[] b)
         throws java.io.IOException

Reads up to 8*b.length bits of data from this input stream into an array of bytes. This method blocks until some input is available.

Overrides:

read in class java.io.FilterInputStream

Parameters:

b - the buffer into which the data is read.

Returns:

the total number of bits read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

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

See Also:

read(byte[], int, int)

read

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

Reads up to len bits of data from this input stream into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

Overrides:

read in class java.io.FilterInputStream

Parameters:

b - the buffer into which the data is read.

off - the start bit offset in the destination array b

len - the maximum number of bits read.

Returns:

the total number of bits read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

java.lang.NullPointerException - If b is null.

java.lang.IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than 8*b.length - off

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

skip

public long skip(long n)
          throws java.io.IOException

Overrides:

skip in class java.io.FilterInputStream

Throws:

java.io.IOException

available

public int available()
              throws java.io.IOException

Returns an estimate of the number of bits that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bits will not block, but may read or skip fewer fewer.

This method returns the result of in.available().

Overrides:

available in class java.io.FilterInputStream

Returns:

an estimate of the number of bits that can be read (or skipped over) from this input stream without blocking.

Throws:

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

mark

public void mark(int readlimit)

Overrides:

mark in class java.io.FilterInputStream

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.FilterInputStream

Throws:

java.io.IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.FilterInputStream