Package com.itextpdf.kernel.pdf

Class FlateCompressionStrategy

java.lang.Object

com.itextpdf.kernel.pdf.FlateCompressionStrategy

All Implemented Interfaces:

IStreamCompressionStrategy

       public class FlateCompressionStrategy extends Object implements IStreamCompressionStrategy
      

A compression strategy that uses the Flate (DEFLATE) compression algorithm for PDF streams.

This strategy implements the IStreamCompressionStrategy interface and provides Flate compression.

Constructor Summary

Constructors

Constructor	Description
FlateCompressionStrategy()	Constructs a new FlateCompressionStrategy instance.

Method Summary

Modifier and Type	Method	Description
OutputStream	createNewOutputStream(OutputStream original, PdfStream stream)	Creates a new output stream with Flate compression applied.
PdfObject	getDecodeParams()	Returns the decode parameters for the Flate filter.
PdfName	getFilterName()	Returns the name of the compression filter.

Methods inherited from class java.lang.Object

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

Constructor Details

FlateCompressionStrategy

             public FlateCompressionStrategy()
            

Constructs a new FlateCompressionStrategy instance.

Method Details

getFilterName

             public PdfName getFilterName()
            

Returns the name of the compression filter.

Specified by:

getFilterName in interface IStreamCompressionStrategy

Returns:

PdfName.FlateDecode representing the Flate compression filter

getDecodeParams

             public PdfObject getDecodeParams()
            

Returns the decode parameters for the Flate filter.

This implementation returns null as no special decode parameters are required for standard Flate compression.

Specified by:

getDecodeParams in interface IStreamCompressionStrategy

Returns:

null as no decode parameters are needed

createNewOutputStream

             public OutputStream createNewOutputStream
             (OutputStream original, PdfStream stream)
            

Creates a new output stream with Flate compression applied.

This method wraps the original output stream in a DeflaterOutputStream that applies Flate compression using the compression level specified in the PDF stream and a 32KB buffer for optimal performance.

Specified by:

createNewOutputStream in interface IStreamCompressionStrategy

Parameters:

original - the original output stream to wrap

stream - the PDF stream containing compression configuration

Returns:

a new DeflaterOutputStream that compresses data using the Flate algorithm