Package org.bouncycastle.openpgp

Class PGPCompressedData

java.lang.Object

org.bouncycastle.openpgp.PGPCompressedData

All Implemented Interfaces:

CompressionAlgorithmTags

public class PGPCompressedData
extends Object
implements CompressionAlgorithmTags

A PGP compressed data object.

Field Summary

Fields inherited from interface org.bouncycastle.bcpg.CompressionAlgorithmTags

BZIP2, UNCOMPRESSED, ZIP, ZLIB

Constructor Summary

Constructors

Constructor	Description
PGPCompressedData(byte[] encData)	Construct a PGP compressed data object from the passed in byte array.
PGPCompressedData(InputStream inStream)	Construct a PGP compressed data object from the passed in input stream.
PGPCompressedData(BCPGInputStream pIn)	Construct a compressed data object, reading a single PacketTags.COMPRESSED_DATA packet from the stream.

Method Summary

Modifier and Type	Method	Description
int	getAlgorithm()	Return the compression algorithm used for this packet.
InputStream	getDataStream()	Return an input stream that decompresses and returns data in the compressed packet.
InputStream	getInputStream()	Return the raw input stream contained in the object.

Methods inherited from class java.lang.Object

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

Constructor Details

PGPCompressedData

public PGPCompressedData(byte[] encData)
                  throws IOException

Construct a PGP compressed data object from the passed in byte array.

Parameters:

encData - an encoding of PGP compressed data.

Throws:

IOException - if an error occurs reading from the PGP input.

PGPCompressedData

public PGPCompressedData(InputStream inStream)
                  throws IOException

Construct a PGP compressed data object from the passed in input stream.

Parameters:

inStream - an input stream containing an encoding of PGP compressed data.

Throws:

IOException - if an error occurs reading from the PGP input.

PGPCompressedData

public PGPCompressedData(BCPGInputStream pIn)
                  throws IOException

Construct a compressed data object, reading a single PacketTags.COMPRESSED_DATA packet from the stream.

Parameters:

pIn - a PGP input stream, with a compressed data packet as the current packet.

Throws:

IOException - if an error occurs reading the packet from the stream.

Method Details

getAlgorithm

public int getAlgorithm()

Return the compression algorithm used for this packet.

Returns:

the compression algorithm code

getInputStream

public InputStream getInputStream()

Return the raw input stream contained in the object.

Note that this stream is shared with the decompression stream, so consuming the returned stream will affect decompression.

Returns:

the raw data in the compressed data packet.

getDataStream

public InputStream getDataStream()
                          throws PGPException

Return an input stream that decompresses and returns data in the compressed packet.

Returns:

a stream over the uncompressed data.

Throws:

PGPException - if an error occurs constructing the decompression stream.