Class BitOutputStream

java.lang.Object

java.io.OutputStream

BitOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class BitOutputStream
extends OutputStream

Constructor Summary

Constructors

Constructor and Description
BitOutputStream(OutputStream out) Create a stream that writes-through to the OutputStream object passed as a parameter.
BitOutputStream(String filename) Construct a bit-at-a-time output stream with specified file name.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Releases system resources associated with file and flushes bits not yet written.
void	flush() Flushes bits not yet written, must be called by client programs if close isn't called.
void	write(int b) Required by OutputStream subclasses, write the low 8-bits to the underlying outputstream
void	writeBits(int howManyBits, int value) Write specified number of bits from value to a file.

Methods inherited from class java.io.OutputStream

write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

BitOutputStream

public BitOutputStream(OutputStream out)

Create a stream that writes-through to the OutputStream object passed as a parameter.

Parameters:

out - is the output stream to which bits are written

BitOutputStream

public BitOutputStream(String filename)

Construct a bit-at-a-time output stream with specified file name.

Parameters:

filename - is the name of the file being written

Throws:

RuntimeException - if opening file fails for either FileNotFound or for Security exceptoins

Method Detail

write

public void write(int b)
           throws IOException

Required by OutputStream subclasses, write the low 8-bits to the underlying outputstream

Specified by:

write in class OutputStream

Throws:

IOException

flush

public void flush()

Flushes bits not yet written, must be called by client programs if close isn't called.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

RuntimeException - if there's a problem writing bits

close

public void close()

Releases system resources associated with file and flushes bits not yet written. Either this function or flush must be called or not all bits will be written

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

RuntimeException - if close fails

writeBits

public void writeBits(int howManyBits,
             int value)

Write specified number of bits from value to a file.

Parameters:

howManyBits - is number of bits to write (1-32)

value - is source of bits, rightmost bits are written

Throws:

RuntimeException - if there's an I/O problem writing bits