org.json.zip

Class BitOutputStream

java.lang.Object

org.json.zip.BitOutputStream

All Implemented Interfaces:

BitWriter

public class BitOutputStream
extends Object
implements BitWriter

This is a big endian bit writer. It writes its bits to an OutputStream.

Version:

2013-04-18

Constructor Summary

Constructors

Constructor and Description
BitOutputStream(OutputStream out) Use an OutputStream to produce a BitWriter.

Method Summary

Methods

Modifier and Type	Method and Description
long	nrBits() Returns the number of bits that have been written to this bitOutputStream.
void	one() Write a 1 bit.
void	pad(int factor) Pad the rest of the block with zeroes and flush. pad(8) flushes the last unfinished byte.
void	write(int bits, int width) Write some bits.
void	zero() Write a 0 bit.

Methods inherited from class java.lang.Object

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

Constructor Detail

BitOutputStream

public BitOutputStream(OutputStream out)

Use an OutputStream to produce a BitWriter. The BitWriter will send its bits to the OutputStream as each byte is filled.

Parameters:

out - An Output Stream

Method Detail

nrBits

public long nrBits()

Returns the number of bits that have been written to this bitOutputStream. This may include bits that have not yet been written to the underlying outputStream.

Specified by:

nrBits in interface BitWriter

one

public void one()
         throws IOException

Write a 1 bit.

Specified by:

one in interface BitWriter

Throws:

IOException

pad

public void pad(int factor)
         throws IOException

Pad the rest of the block with zeroes and flush. pad(8) flushes the last unfinished byte. The underlying OutputStream will be flushed.

Specified by:

pad in interface BitWriter

Parameters:

factor - The size of the block to pad. This will typically be 8, 16, 32, 64, 128, 256, etc.

Throws:

IOException

write

public void write(int bits,
         int width)
           throws IOException

Write some bits. Up to 32 bits can be written at a time.

Specified by:

write in interface BitWriter

Parameters:

bits - The bits to be written.

width - The number of bits to write. (0..32)

Throws:

IOException

zero

public void zero()
          throws IOException

Write a 0 bit.

Specified by:

zero in interface BitWriter

Throws:

IOException