Package org.apache.pdfbox.filter
Interface Filter
- All Known Implementing Classes:
ASCII85Filter,ASCIIHexFilter,CCITTFaxDecodeFilter,CryptFilter,DCTFilter,FlateFilter,IdentityFilter,JBIG2Filter,JPXFilter,LZWFilter,RunLengthDecodeFilter
public interface Filter
This is the interface that will be used to apply filters to a byte stream.
- Version:
- $Revision: 1.7 $
- Author:
- Ben Litchfield
-
Method Summary
Modifier and TypeMethodDescriptionvoiddecode(InputStream compressedData, OutputStream result, COSDictionary options, int filterIndex) This will decode some compressed data.voidencode(InputStream rawData, OutputStream result, COSDictionary options, int filterIndex) This will encode some data.
-
Method Details
-
decode
void decode(InputStream compressedData, OutputStream result, COSDictionary options, int filterIndex) 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.filterIndex- The index to the filter being decoded.- Throws:
IOException- If there is an error decompressing the stream.
-
encode
void encode(InputStream rawData, OutputStream result, COSDictionary options, int filterIndex) 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.filterIndex- The index to the filter being encoded.- Throws:
IOException- If there is an error compressing the stream.
-