Package org.sturrock.cassette.cassettej

Interface ContentEncoding

All Known Implementing Classes:

GZIPContentEncoding

public interface ContentEncoding

Defines an encoding for use with a ContentAddressableStore This allows data to be stored in that format and retrieved using that format directly - ie the work to compress/decompress is done once at storage time rather than multiple times at retrieval time.

Method Summary

Modifier and Type	Method	Description
InputStream	decode(InputStream stream)	Decode a stream with this encoding type and return a new stream.
DeflaterOutputStream	encode(OutputStream stream)	Encode a stream and return a new stream with this encoding type.
String	getName()	Get the name of the encoding - eg gzip, deflate

Method Detail

getName

String getName()

Get the name of the encoding - eg gzip, deflate

Returns:

encode

DeflaterOutputStream encode(OutputStream stream)
                     throws IOException

Encode a stream and return a new stream with this encoding type. Note that this method explicitly returns a DeflaterOutputStream. The caller can then call finish() on the stream. See DeflaterOutputStream.finish() for more details.

Parameters:

stream - The unencoded stream

Returns:

The encoded stream

Throws:

IOException

decode

InputStream decode(InputStream stream)
            throws IOException

Decode a stream with this encoding type and return a new stream.

Parameters:

stream - The encoded stream

Returns:

The decoded stream

Throws:

IOException