com.itextpdf.io.source

Class DeflaterOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.util.zip.DeflaterOutputStream

com.itextpdf.io.source.DeflaterOutputStream

All Implemented Interfaces:

IFinishable, Closeable, Flushable, AutoCloseable

public class DeflaterOutputStream
extends DeflaterOutputStream
implements IFinishable

An output stream that compresses data using the DEFLATE compression algorithm. This is a wrapper around DeflaterOutputStream that provides convenient constructors for specifying compression level and buffer size.

The compression level can be set to values between 0 (no compression) and 9 (maximum compression), or use -1 for the default compression level.

Field Summary

Fields inherited from class java.util.zip.DeflaterOutputStream

buf, def

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
DeflaterOutputStream(OutputStream out) Creates a new deflater output stream with default compression level and buffer size.
DeflaterOutputStream(OutputStream out, int level) Creates a new deflater output stream with a specified compression level and default buffer size.
DeflaterOutputStream(OutputStream out, int level, int size) Creates a new deflater output stream with a specified compression level and buffer size.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this output stream and releases any system resources associated with it.
void	finish() Finishes writing compressed data to the output stream without closing the underlying stream.

Methods inherited from class java.util.zip.DeflaterOutputStream

deflate, flush, write, write

Methods inherited from class java.io.FilterOutputStream

write

Methods inherited from class java.lang.Object

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

Constructor Detail

DeflaterOutputStream

public DeflaterOutputStream(OutputStream out,
                            int level,
                            int size)

Creates a new deflater output stream with a specified compression level and buffer size.

Parameters:

out - the output stream to write compressed data to

level - the compression level (0-9, or -1 for default)

size - the buffer size in bytes

DeflaterOutputStream

public DeflaterOutputStream(OutputStream out,
                            int level)

Creates a new deflater output stream with a specified compression level and default buffer size.

Parameters:

out - the output stream to write compressed data to

level - the compression level (0-9, or -1 for default)

DeflaterOutputStream

public DeflaterOutputStream(OutputStream out)

Creates a new deflater output stream with default compression level and buffer size.

Parameters:

out - the output stream to write compressed data to

Method Detail

close

public void close()
           throws IOException

Closes this output stream and releases any system resources associated with it. This method finishes writing compressed data to the output stream before closing.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class DeflaterOutputStream

Throws:

IOException - if an I/O error occurs

finish

public void finish()
            throws IOException

Finishes writing compressed data to the output stream without closing the underlying stream. This method completes the compression process and ends the deflater, releasing its resources.

Specified by:

finish in interface IFinishable

Overrides:

finish in class DeflaterOutputStream

Throws:

IOException - if an I/O error occurs