Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.pdfbox.filter
Interface Filter

All Known Implementing Classes:
  ASCII85Filter, ASCIIHexFilter, CCITTFaxDecodeFilter, DCTFilter, FlateFilter, LZWFilter, RunLengthDecodeFilter

public interface Filter

This is the interface that will be used to apply filters to a byte stream.

Version:
  $Revision: 1.6 $
Author:
  Ben Litchfield

Method Summary
`void` | `decode(InputStream compressedData, OutputStream result, COSDictionary options)` This will decode some compressed data.
`void` | `encode(InputStream rawData, OutputStream result, COSDictionary options)` This will encode some data.

Method Detail

### decode

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

  This will decode some compressed data.

  Parameters:
    `compressedData` - The compressed byte stream.
    `result` - The place to write the uncompressed byte stream.
    `options` - The options to use to encode the data.
  Throws:
    `IOException` - If there is an error decompressing the stream.

### encode

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

  This will encode some data.

  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.
  Throws:
    `IOException` - If there is an error compressing the stream.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD