com.itextpdf.kernel.pdf.filters

Class FlateDecodeFilter

java.lang.Object

com.itextpdf.kernel.pdf.filters.FlateDecodeFilter

All Implemented Interfaces:

IFilterHandler

public class FlateDecodeFilter
extends Object
implements IFilterHandler

Handles FlateDecode filter.

Constructor Summary

Constructors

Constructor and Description
FlateDecodeFilter() Creates a FlateDecodeFilter.
FlateDecodeFilter(boolean strictDecoding) Creates a FlateDecodeFilter.

Method Summary

Modifier and Type	Method and Description
byte[]	decode(byte[] b, PdfName filterName, PdfObject decodeParams, PdfDictionary streamDictionary) Decode the byte[] using the provided filterName.
static byte[]	decodePredictor(byte[] in, PdfObject decodeParams)
static byte[]	flateDecode(byte[] in, boolean strict) A helper to flateDecode.
boolean	isStrictDecoding() Checks whether the decoder will try to read a corrupted stream (not strict) or not (strict)
FlateDecodeFilter	setStrictDecoding(boolean strict) Defines how the corrupted streams should be treated.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlateDecodeFilter

public FlateDecodeFilter()

Creates a FlateDecodeFilter.

FlateDecodeFilter

public FlateDecodeFilter(boolean strictDecoding)

Creates a FlateDecodeFilter.

Parameters:

strictDecoding - defines whether the decoder will try to read a corrupted stream

Method Detail

isStrictDecoding

public boolean isStrictDecoding()

Checks whether the decoder will try to read a corrupted stream (not strict) or not (strict)

Returns:

true if the decoder will try to read a corrupted stream otherwise false

setStrictDecoding

public FlateDecodeFilter setStrictDecoding(boolean strict)

Defines how the corrupted streams should be treated.

Parameters:

strict - true if the decoder should try to read a corrupted stream otherwise false

Returns:

the decoder

decode

public byte[] decode(byte[] b,
                     PdfName filterName,
                     PdfObject decodeParams,
                     PdfDictionary streamDictionary)

Description copied from interface: IFilterHandler

Decode the byte[] using the provided filterName.

Specified by:

decode in interface IFilterHandler

Parameters:

b - the bytes that need to be decoded

filterName - PdfName of the filter

decodeParams - decode parameters

streamDictionary - the dictionary of the stream. Can contain additional information needed to decode the byte[].

Returns:

decoded byte array

flateDecode

public static byte[] flateDecode(byte[] in,
                                 boolean strict)

A helper to flateDecode.

Parameters:

in - the input data

strict - true to read a correct stream. false to try to read a corrupted stream.

Returns:

the decoded data

decodePredictor

public static byte[] decodePredictor(byte[] in,
                                     PdfObject decodeParams)

Parameters:

in - Input byte array.

decodeParams - PdfDictionary of decodeParams.

Returns:

a byte array