org.itadaki.bzip2

Class BZip2OutputStream

java.lang.Object

java.io.OutputStream

org.itadaki.bzip2.BZip2OutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class BZip2OutputStream
extends OutputStream

An OutputStream wrapper that compresses BZip2 data

Instances of this class are not threadsafe.

Constructor Summary

Constructors

Constructor and Description
BZip2OutputStream(OutputStream outputStream) Constructs a BZip2 stream compressor with the maximum (900,000 byte) block size
BZip2OutputStream(OutputStream outputStream, int blockSizeMultiplier)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	finish() Compresses and writes out any as yet unwritten data, then writes the end of the BZip2 stream.
void	write(byte[] data, int offset, int length)
void	write(int value)

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

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

Constructor Detail

BZip2OutputStream

public BZip2OutputStream(OutputStream outputStream,
                 int blockSizeMultiplier)
                  throws IOException

Parameters:

outputStream - The output stream to write to

blockSizeMultiplier - The BZip2 block size as a multiple of 100,000 bytes (minimum 1, maximum 9). Larger block sizes require more memory for both compression and decompression, but give better compression ratios. 9 will usually be the best value to use

Throws:

IOException - on any I/O error writing to the output stream

BZip2OutputStream

public BZip2OutputStream(OutputStream outputStream)
                  throws IOException

Constructs a BZip2 stream compressor with the maximum (900,000 byte) block size

Parameters:

outputStream - The output stream to write to

Throws:

IOException - on any I/O error writing to the output stream

Method Detail

write

public void write(int value)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] data,
         int offset,
         int length)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

finish

public void finish()
            throws IOException

Compresses and writes out any as yet unwritten data, then writes the end of the BZip2 stream. The underlying OutputStream is not closed

Throws:

IOException - on any I/O error writing to the output stream