org.apache.pdfbox.filter
Class LZWFilter

java.lang.Object
  org.apache.pdfbox.filter.LZWFilter

All Implemented Interfaces:

Filter

public class LZWFilter
extends Object
implements Filter

This is the filter used for the LZWDecode filter.

Author:

Ben Litchfield, Tilman Hausherr

Field Summary

static long	CLEAR_TABLE The LZW clear table code.
static long	EOD The LZW end of data code.

Constructor Summary

LZWFilter()

Method Summary

void	decode(InputStream compressedData, OutputStream result, COSDictionary options, int filterIndex) This will decode some compressed data.
void	encode(InputStream rawData, OutputStream result, COSDictionary options, int filterIndex) This will encode some data.

Methods inherited from class java.lang.Object

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

Field Detail

CLEAR_TABLE

public static final long CLEAR_TABLE

The LZW clear table code.

See Also:

Constant Field Values

EOD

public static final long EOD

The LZW end of data code.

See Also:

Constant Field Values

Constructor Detail

LZWFilter

public LZWFilter()

Method Detail

decode

public void decode(InputStream compressedData,
                   OutputStream result,
                   COSDictionary options,
                   int filterIndex)
            throws IOException

This will decode some compressed data.

Specified by:

decode in interface Filter

Parameters:

compressedData - The compressed byte stream.

result - The place to write the uncompressed byte stream.

options - The options to use to encode the data.

filterIndex - The index to the filter being decoded.

Throws:

IOException - If there is an error decompressing the stream.

encode

public void encode(InputStream rawData,
                   OutputStream result,
                   COSDictionary options,
                   int filterIndex)
            throws IOException

This will encode some data.

Specified by:

encode in interface Filter

Parameters:

rawData - The raw data to encode.

result - The place to write to encoded results to.

options - The options to use to encode the data.

filterIndex - The index to the filter being encoded.

Throws:

IOException - If there is an error compressing the stream.