Package htsjdk.samtools.cram.io
Interface BitOutputStream
-
- All Superinterfaces:
AutoCloseable,Closeable,Flushable
- All Known Implementing Classes:
DefaultBitOutputStream
public interface BitOutputStream extends Closeable, Flushable
An interface to describe the requirements for writing out bits as opposed to bytes. Implementors must keep track of the amount of data written similar toOutputStreamconcept and provide flush/close functionality accordingly.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidwrite(boolean bit)Write a single bit specified in the boolean argument.voidwrite(boolean bit, long repeat)Write a single bit specified in the boolean argument repeatedly.voidwrite(byte bitContainer, int nofBits)Write specified number of bits supplied in the byte value.voidwrite(int bitContainer, int nofBits)Write specified number of bits supplied in the integer value.voidwrite(long bitContainer, int nofBits)Write specified number of bits supplied in the long value.
-
-
-
Method Detail
-
write
void write(int bitContainer, int nofBits) throws IOExceptionWrite specified number of bits supplied in the integer value. The method is naturally limited to 32 bits max.- Parameters:
bitContainer- an integer containing the bits to be written outnofBits- the number of bits to written out, minimum 0, maximum 32.- Throws:
IOException- as per streaming contract in java.
-
write
void write(long bitContainer, int nofBits) throws IOExceptionWrite specified number of bits supplied in the long value. The method is naturally limited to 64 bits max.- Parameters:
bitContainer- an integer containing the bits to be written outnofBits- the number of bits to written out, minimum 0, maximum 64.- Throws:
IOException- as per streaming contract in java.
-
write
void write(byte bitContainer, int nofBits) throws IOExceptionWrite specified number of bits supplied in the byte value. The method is naturally limited to 8 bits max.- Parameters:
bitContainer- an integer containing the bits to be written outnofBits- the number of bits to written out, minimum 0, maximum 8.- Throws:
IOException- as per streaming contract in java.
-
write
void write(boolean bit) throws IOExceptionWrite a single bit specified in the boolean argument.- Parameters:
bit- emit 1 if true, 0 otherwise.- Throws:
IOException- as per streaming contract in java.
-
write
void write(boolean bit, long repeat) throws IOExceptionWrite a single bit specified in the boolean argument repeatedly.- Parameters:
bit- emit 1 if true, 0 otherwise.repeat- the number of bits to emit.- Throws:
IOException- as per streaming contract in java.
-
-