org.bouncycastle.openpgp

Class PGPCompressedDataGenerator

public class PGPCompressedDataGenerator extends Object implements CompressionAlgorithmTags, StreamGenerator

class for producing compressed data packets.
Constructor Summary
PGPCompressedDataGenerator(int algorithm)
PGPCompressedDataGenerator(int algorithm, int compression)
Method Summary
voidclose()
Close the compressed object - this is equivalent to calling close on the stream returned by the open() method.
OutputStreamopen(OutputStream out)
Return an outputstream which will save the data being written to the compressed object.
OutputStreamopen(OutputStream out, byte[] buffer)
Return an outputstream which will compress the data as it is written to it.

Constructor Detail

PGPCompressedDataGenerator

public PGPCompressedDataGenerator(int algorithm)

PGPCompressedDataGenerator

public PGPCompressedDataGenerator(int algorithm, int compression)

Method Detail

close

public void close()
Close the compressed object - this is equivalent to calling close on the stream returned by the open() method.

Throws: IOException

open

public OutputStream open(OutputStream out)
Return an outputstream which will save the data being written to the compressed object. The stream can be closed off by either calling close() on the stream or close() on the generator.

Parameters: out

Returns: OutputStream

Throws: IOException, IllegalStateException

open

public OutputStream open(OutputStream out, byte[] buffer)
Return an outputstream which will compress the data as it is written to it. The stream will be written out in chunks according to the size of the passed in buffer and can be closed off by either calling close() on the stream or close() on the generator.

Note: if the buffer is not a power of 2 in length only the largest power of 2 bytes worth of the buffer will be used.

Note: using this may break compatability with RFC 1991 compliant tools. Only recent OpenPGP implementations are capable of accepting these streams.

Parameters: out buffer the buffer to use.

Returns: OutputStream

Throws: IOException PGPException