htsjdk.samtools.cram.io

Interface BitInputStream

All Known Implementing Classes:

DefaultBitInputStream

public interface BitInputStream

An interface to describe the requirements for reading bit data as opposed to bytes. Implementors must keep track of the amount of data read similar to InputStream concept.

Method Summary

Modifier and Type	Method and Description
boolean	readBit() Reads a single bit from the stream.
int	readBits(int length) Read specified number of bits from the stream.
long	readLongBits(int length) Read specified number of bits from the stream.

Method Detail

readBit

boolean readBit()
         throws java.io.IOException

Reads a single bit from the stream.

Throws:

java.io.IOException - as per streaming contract in java.

readBits

int readBits(int length)
      throws java.io.IOException

Read specified number of bits from the stream. The bits are return in an integer value.

Parameters:

length - number of bits to read

Throws:

java.io.IOException - as per streaming contract in java.

readLongBits

long readLongBits(int length)
           throws java.io.IOException

Read specified number of bits from the stream. The bits are return in a long value.

Parameters:

length - number of bits to read

Throws:

java.io.IOException - as per streaming contract in java.