Summary: Ctors | Inherited Methods | [Expand All]
public class

# FlateEncode

extends Filter

java.lang.Object
↳ | com.pdftron.filters.Filter
| ↳ | com.pdftron.filters.FlateEncode

## Class Overview

FlateEncode filter can be used to compress any data stream using Flate (i.e. ZIP) compression method.

## Summary

Public Constructors
| FlateEncode(Filter input_filter) Constructor for FlateEncoder for specified input data stream
| FlateEncode(Filter input_filter, int compression_level) Instantiates a new FlateEncode for specified input data stream and specified compression level
| FlateEncode(Filter input_filter, int compression_level, long buf_sz) Instantiates a new FlateEncode for specified Filter, compression level and buffer size

[Expand] Inherited Methods
From class com.pdftron.filters.Filter
static Filter | __Create(long impl, Filter attached)
long | __GetHandle()
void | __SetRefHandle(Object ref)
void | attachFilter(Filter attach_filter) Attaches a filter to the this filter.
boolean | canSeek() determine whether the stream supports seeking
void | close() Frees the native memory of the object.
Filter | createInputIterator() Create Filter iterator.
void | destroy() Frees the native memory of the object.
void | flush() Forces any data remaining in the buffer to be written to input or output filter.
void | flushAll() Forces any data remaining in the filter chain to the source or destination.
Filter | getAttachedFilter() Get the attached filter.
String | getDecodeName() Get the decode name.
String | getFilePath() Get the file path.
String | getName() Get the name.
Filter | getSourceFilter() Get the source filter.
boolean | isInputFilter() Checks if is input filter.
Filter | releaseAttachedFilter() Release the ownership of the attached filter.
void | seek(long offset, int origin) When overridden in a derived class, sets the position within the current stream.
void | setStreamLength(long bytes) The functions specifies the length of the data stream.
long | size() Returns the size of buffer returned by Begin().
long | tell() Reports the current read position in the stream relative to the stream origin.
void | writeToFile(String path, boolean append) Writes the entire filter, starting at current position, to specified filepath.
From class java.lang.Object
boolean | equals(Object arg0)
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()
From interface java.lang.AutoCloseable
abstract void | close()

## Public Constructors

#### public FlateEncode (Filter input_filter)

Constructor for FlateEncoder for specified input data stream

##### Parameters

input_filter | input data stream

##### Throws

PDFNetException |

#### public FlateEncode (Filter input_filter, int compression_level)

Instantiates a new FlateEncode for specified input data stream and specified compression level

##### Parameters

input_filter | the input data stream

##### Throws

PDFNetException |

#### public FlateEncode (Filter input_filter, int compression_level, long buf_sz)

Instantiates a new FlateEncode for specified Filter, compression level and buffer size

##### Parameters

input_filter | the input data stream
buf_sz | the buffer size

##### Throws

PDFNetException |