edu.msoe.jones.bitstream

Class BitOutputStream

java.lang.Object

edu.msoe.jones.bitstream.BitOutputStream

All Implemented Interfaces:

java.lang.AutoCloseable

public final class BitOutputStream
extends java.lang.Object
implements java.lang.AutoCloseable

A file outputStream stream that takes integer representations of bits (1s and 0s) and writes them as bits to a file. The bits are stored in a buffer until 8 bits have been added, then a byte is written. When closed, padding is added to fill out the remaining bits.

Constructor Summary

Constructors

Constructor and Description
BitOutputStream(java.io.OutputStream out) Constructs a BitOutputStream using the given OutputStream.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the stream and the underlying OutputStream.
void	write(int bit) Writes a bit to the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

BitOutputStream

public BitOutputStream(java.io.OutputStream out)

Constructs a BitOutputStream using the given OutputStream.

Parameters:

out - the backing OutputStream

Throws:

java.lang.NullPointerException - if the outputStream stream is null

Method Detail

write

public void write(int bit)
           throws java.io.IOException

Writes a bit to the stream. The specified bit must be 0 or 1.

Parameters:

bit - the bit to write, which must be 0 or 1

Throws:

java.io.IOException - if file cannot be read

close

public void close()
           throws java.io.IOException

Closes the stream and the underlying OutputStream. If the buffer is not empty, the remaining bits are padded with zeros and the byte is written before closing.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if an I/O exception occurred