Package com.helger.base.codec.impl

Class GZIPCodec

java.lang.Object

com.helger.base.codec.impl.GZIPCodec

All Implemented Interfaces:

IByteArrayCodec, IByteArrayDecoder, IByteArrayEncoder, IByteArrayStreamDecoder, IByteArrayStreamEncoder, ICodec<byte[]>, IDecoder<byte[],byte[]>, IEncoder<byte[],byte[]>

public class GZIPCodec
extends Object
implements IByteArrayCodec

Encoder and decoder for GZip compression

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
GZIPCodec()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	decode(byte @Nullable [] aEncodedBuffer, int nOfs, int nLen, @NonNull OutputStream aOS)	Decode the passed GZIP compressed buffer and write the decoded bytes to the output stream.
void	encode(byte @Nullable [] aDecodedBuffer, int nOfs, int nLen, @NonNull OutputStream aOS)	Encode the passed buffer using GZIP compression and write it to the output stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.base.codec.IByteArrayDecoder

getDecoded, getDecoded, getMaximumDecodedLength

Methods inherited from interface com.helger.base.codec.IByteArrayStreamDecoder

decode, getDecoded, getDecodedAsString, getDecodedAsString, getDecodedAsString, getDecodedAsString

Methods inherited from interface com.helger.base.codec.IByteArrayStreamEncoder

encode, getEncoded, getEncoded, getEncoded, getEncodedAsString, getEncodedAsString, getEncodedAsString, getMaximumEncodedLength

Constructor Details

GZIPCodec

public GZIPCodec()

Constructor.

Method Details

decode

public void decode(byte @Nullable [] aEncodedBuffer,
 @Nonnegative
 int nOfs,
 @Nonnegative
 int nLen,
 @WillNotClose
 @NonNull OutputStream aOS)

Decode the passed GZIP compressed buffer and write the decoded bytes to the output stream.

Specified by:

decode in interface IByteArrayStreamDecoder

Parameters:

aEncodedBuffer - The GZIP compressed buffer to be decoded. May be null.

nOfs - The offset in the buffer to start decoding from.

nLen - The number of bytes to decode.

aOS - The output stream to write the decoded data to. May not be null.

encode

public void encode(byte @Nullable [] aDecodedBuffer,
 @Nonnegative
 int nOfs,
 @Nonnegative
 int nLen,
 @WillNotClose
 @NonNull OutputStream aOS)

Encode the passed buffer using GZIP compression and write it to the output stream.

Specified by:

encode in interface IByteArrayStreamEncoder

Parameters:

aDecodedBuffer - The buffer to be encoded. May be null.

nOfs - The offset in the buffer to start encoding from.

nLen - The number of bytes to encode.

aOS - The output stream to write the encoded data to. May not be null.