com.helger.commons.codec

Class LZWCodec

java.lang.Object

com.helger.commons.codec.AbstractByteArrayDecoder

com.helger.commons.codec.AbstractByteArrayCodec

com.helger.commons.codec.LZWCodec

All Implemented Interfaces:

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

public class LZWCodec
extends AbstractByteArrayCodec

Encoder and decoder for the LZW algorithm

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	LZWCodec.AbstractLZWDictionary
protected static class	LZWCodec.LZWDecodeDictionary
protected static class	LZWCodec.LZWEncodeDictionary
protected static class	LZWCodec.LZWNode A single LZW node

Constructor Summary

Constructors

Constructor and Description
LZWCodec()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getDecoded(byte[] aEncodedBuffer) Decode a byte array.
static byte[]	getDecodedLZW(byte[] aEncodedBuffer)
static void	getDecodedLZW(InputStream aEncodedIS, OutputStream aOS)
byte[]	getEncoded(byte[] aBuffer) Encode a byte array.
static byte[]	getEncodedLZW(byte[] aBuffer)
static void	getEncodedLZW(byte[] aBuffer, OutputStream aOS) LZW-encode the passed byte array to the passed output stream

Methods inherited from class com.helger.commons.codec.AbstractByteArrayCodec

getEncoded

Methods inherited from class com.helger.commons.codec.AbstractByteArrayDecoder

getDecoded

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

Constructor Detail

LZWCodec

public LZWCodec()

Method Detail

getDecodedLZW

@Nullable
@ReturnsMutableCopy
public static byte[] getDecodedLZW(@Nullable
                                               byte[] aEncodedBuffer)

getDecodedLZW

public static void getDecodedLZW(@Nonnull@WillNotClose
                 InputStream aEncodedIS,
                 @Nonnull@WillNotClose
                 OutputStream aOS)

getDecoded

@Nullable
@ReturnsMutableCopy
public byte[] getDecoded(@Nullable
                                            byte[] aEncodedBuffer)

Description copied from interface: IByteArrayDecoder

Decode a byte array.

Parameters:

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

Returns:

The decoded byte array or null if the parameter was null.

getEncodedLZW

@Nullable
@ReturnsMutableCopy
public static byte[] getEncodedLZW(@Nullable
                                               byte[] aBuffer)

getEncodedLZW

public static void getEncodedLZW(@Nullable
                 byte[] aBuffer,
                 @Nonnull@WillNotClose
                 OutputStream aOS)

LZW-encode the passed byte array to the passed output stream

Parameters:

aBuffer - The buffer to be encoded. May be null in which case nothing happens.

aOS - The output stream to encode the content to. The output stream is not closed after encoding is done! May not be null.

getEncoded

@Nullable
@ReturnsMutableCopy
public byte[] getEncoded(@Nullable
                                            byte[] aBuffer)

Description copied from interface: IByteArrayEncoder

Encode a byte array.

Parameters:

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

Returns:

The encoded byte array or null if the parameter was null.