org.itadaki.bzip2

Class BZip2BlockCompressor

java.lang.Object

org.itadaki.bzip2.BZip2BlockCompressor

public class BZip2BlockCompressor
extends Object

Compresses and writes a single BZip2 block

Constructor Summary

Constructors

Constructor and Description
BZip2BlockCompressor(BZip2BitOutputStream bitOutputStream, int blockSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Compresses and writes out the block
int	getCRC() Gets the CRC of the completed block.
boolean	isEmpty() Determines if any bytes have been written to the block
int	write(byte[] data, int offset, int length) Writes an array to the block
boolean	write(int value) Writes a byte to the block, accumulating to an RLE run where possible

Methods inherited from class java.lang.Object

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

Constructor Detail

BZip2BlockCompressor

public BZip2BlockCompressor(BZip2BitOutputStream bitOutputStream,
                    int blockSize)

Parameters:

bitOutputStream - The BZip2BitOutputStream to which compressed BZip2 data is written

blockSize - The declared block size in bytes. Up to this many bytes will be accepted into the block after Run-Length Encoding is applied

Method Detail

write

public boolean write(int value)

Writes a byte to the block, accumulating to an RLE run where possible

Parameters:

value - The byte to write

Returns:

true if the byte was written, or false if the block is already full

write

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

Writes an array to the block

Parameters:

data - The array to write

offset - The offset within the input data to write from

length - The number of bytes of input data to write

Returns:

The actual number of input bytes written. May be less than the number requested, or zero if the block is already full

close

public void close()
           throws IOException

Compresses and writes out the block

Throws:

IOException - on any I/O error writing the data

isEmpty

public boolean isEmpty()

Determines if any bytes have been written to the block

Returns:

true if one or more bytes has been written to the block, otherwise false

getCRC

public int getCRC()

Gets the CRC of the completed block. Only valid after calling close()

Returns:

The block's CRC