Package eu.bandm.tools.util.files

Class BitOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

eu.bandm.tools.util.files.BitOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class BitOutputStream
extends FilterOutputStream

Output Stream which allows to write single bits sequentially. Bits are written left aligned. Explicit calls to write bytes and primitce types of multiple bytes cause the bit buffer to be flushed. A file can grow like this:

          0    1000 0001      | <= write((byte)0x81);
 
          0    1000 0001      
          1    101. ....      | <= write(true); write(false);write(true);
 
          0    1000 0001      
          1    101. ....      
          2    0000 0001      
          3    0000 0010      | <= write((int)258));
  

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
BitOutputStream(OutputStream out)	Only constructed.

Method Summary

Modifier and Type	Method	Description
void	byteAlign()	Shifts the bits written to the buffer buf to be left aligned, writes the resulting byte and clears the buffer.
void	close()	Closes the output stream after flushing the bit buffer..
void	flush()	Flushes the output stream after flushing the bit buffer.
void	write(byte[] b)	Writes bytes to the output after flushing the bit buffer.
void	write(byte[] b, int off, int len)	Writes bytes to the output after flushing the bit buffer
void	write(int b)	Writes one integer to the output after flushing the bit buffer.
final void	writeBit(boolean b)	Write a boolean value as a bit value.
void	writeBit(int b)	Appends a bit value at the lowest position in the buffer.

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

BitOutputStream

public BitOutputStream(OutputStream out)

Only constructed. Sets the target of the write operations.

Method Details

close

public void close()
           throws IOException

Closes the output stream after flushing the bit buffer..

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException

See Also:

• FilterOutputStream.close()

flush

public void flush()
           throws IOException

Flushes the output stream after flushing the bit buffer.

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException

See Also:

• FilterOutputStream.flush()

write

public void write(byte[] b)
           throws IOException

Writes bytes to the output after flushing the bit buffer.

Overrides:

write in class FilterOutputStream

Throws:

IOException

See Also:

• FilterOutputStream.write(byte[])

write

public void write(byte[] b,
 int off,
 int len)
           throws IOException

Writes bytes to the output after flushing the bit buffer

Overrides:

write in class FilterOutputStream

Throws:

IOException

See Also:

• FilterOutputStream.write(byte[],int,int)

write

public void write(int b)
           throws IOException

Writes one integer to the output after flushing the bit buffer.

Overrides:

write in class FilterOutputStream

Throws:

IOException

See Also:

• FilterOutputStream.write(int)

byteAlign

public void byteAlign()
               throws IOException

Shifts the bits written to the buffer buf to be left aligned, writes the resulting byte and clears the buffer.

Throws:

IOException

writeBit

public final void writeBit(boolean b)
                    throws IOException

Write a boolean value as a bit value.

Throws:

IOException

writeBit

public void writeBit(int b)
              throws IOException

Appends a bit value at the lowest position in the buffer. If the buffer is full, flush it as in byteAlign().

Throws:

IOException