Package com.helger.commons.codec

Class FlateCodec

java.lang.Object

com.helger.commons.codec.FlateCodec

All Implemented Interfaces:

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

public class FlateCodec
extends Object
implements IByteArrayCodec

Encoder and decoder for flate compression

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
FlateCodec()

Method Summary

Modifier and Type	Method	Description
void	decode(byte[] aEncodedBuffer, int nOfs, int nLen, OutputStream aOS)	Decode (part of) a byte array.
void	encode(byte[] aDecodedBuffer, int nOfs, int nLen, OutputStream aOS)	Encode (part of) a byte array to an OutputStream.
static boolean	isZlibHead(byte[] buf, int nOfs, int nLen)

Methods inherited from class java.lang.Object

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

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

getDecoded, getDecoded, getMaximumDecodedLength

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

decode, getDecoded, getDecodedAsString, getDecodedAsString, getDecodedAsString, getDecodedAsString

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

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

Constructor Detail

FlateCodec

public FlateCodec()

Method Detail

isZlibHead

public static boolean isZlibHead(@Nonnull
                                 byte[] buf,
                                 @Nonnegative
                                 int nOfs,
                                 @Nonnegative
                                 int nLen)

decode

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

Description copied from interface: IByteArrayStreamDecoder

Decode (part of) a byte array.

Specified by:

decode in interface IByteArrayStreamDecoder

Parameters:

aEncodedBuffer - The byte array to be decoded. May be null.

nOfs - Offset into the byte array to start from.

nLen - Number of bytes starting from offset to consider.

aOS - The output stream to write to. May not be null and is NOT closed afterwards!

encode

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

Description copied from interface: IByteArrayStreamEncoder

Encode (part of) a byte array to an OutputStream.

Specified by:

encode in interface IByteArrayStreamEncoder

Parameters:

aDecodedBuffer - The byte array to be encoded. May be null.

nOfs - Offset into the byte array to start from.

nLen - Number of bytes starting from offset to consider.

aOS - The output stream to write to. May not be null and is NOT closed afterwards!