Apache PDFBox 3.0.4 · org.apache.pdfbox.filter.Filter

Modifier and Type	Field and Description
private static final Log	LOG
public static final String	SYSPROP_DEFLATELEVEL Compression Level System Property.

Access	Constructor and Description
protected	Filter() Constructor.

Method Summary

Modifier and Type	Method and Description
public abstract DecodeResult	Returns: repaired parameters dictionary, or the original parameters dictionary decode(InputStream the encoded byte stream encoded, OutputStream the stream where decoded data will be written decoded, COSDictionary the parameters used for decoding parameters, int the index to the filter being decoded index) Decodes data, producing the original non-encoded data.
public DecodeResult	Returns: repaired parameters dictionary, or the original parameters dictionary decode(InputStream the encoded byte stream encoded, OutputStream the stream where decoded data will be written decoded, COSDictionary the parameters used for decoding parameters, int the index to the filter being decoded index, DecodeOptions additional options for decoding options) Decodes data, with optional DecodeOptions.
public static RandomAccessRead	Returns: the decoded stream data decode(InputStream the input stream holding the encoded data encoded, List<Filter> list of filters to be used for decoding filterList, COSDictionary the parameters used for decoding parameters, DecodeOptions additional options for decoding options, List<DecodeResult> list of optional decoding results for each filter results) Decodes data, with optional DecodeOptions.
public final void	encode(InputStream the byte stream to encode input, OutputStream the stream where encoded data will be written encoded, COSDictionary the parameters used for encoding parameters, int the index to the filter being encoded index) Encodes data.
protected abstract void	encode(InputStream input, OutputStream encoded, COSDictionary parameters)
public static final ImageReader	Returns: The image reader for the format. findImageReader(String The image format to search for. formatName, String The probably cause if something goes wrong. errorCause) Finds a suitable image reader for an image format.
public static final ImageReader	Returns: The image reader for the format. findRasterReader(String The image format to search for. formatName, String The probably cause if something goes wrong. errorCause) Finds a suitable image raster reader for an image format.
public static int	Returns: the ZIP compression level configured for PDFBox getCompressionLevel()
protected COSDictionary	getDecodeParams(COSDictionary dictionary, int index)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

LOG	back to summary
private static final Log LOG

SYSPROP_DEFLATELEVEL	back to summary
public static final String SYSPROP_DEFLATELEVEL Compression Level System Property. Set this to a value from 0 to 9 to change the zlib deflate compression level used to compress /Flate streams. The default value is -1 which is `Deflater#DEFAULT_COMPRESSION`. To set maximum compression, use `System.setProperty(Filter.SYSPROP_DEFLATELEVEL, "9");`

Filter	back to summary
protected Filter() Constructor.

Method Detail

decode	back to summary
public abstract DecodeResult decode(InputStream encoded, OutputStream decoded, COSDictionary parameters, int index) throws IOException Decodes data, producing the original non-encoded data. Parameters encoded:InputStream the encoded byte stream decoded:OutputStream the stream where decoded data will be written parameters:COSDictionary the parameters used for decoding index:int the index to the filter being decoded Returns:DecodeResult repaired parameters dictionary, or the original parameters dictionary Exceptions IOException: if the stream cannot be decoded

decode

back to summary

public abstract DecodeResult decode(InputStream encoded, OutputStream decoded, COSDictionary parameters, int index) throws IOException

Decodes data, producing the original non-encoded data.

Parameters

encoded:InputStream: the encoded byte stream
decoded:OutputStream: the stream where decoded data will be written
parameters:COSDictionary: the parameters used for decoding
index:int: the index to the filter being decoded

Returns:DecodeResult

repaired parameters dictionary, or the original parameters dictionary

Exceptions

IOException:: if the stream cannot be decoded

decode back to summary

decode	back to summary
public DecodeResult decode(InputStream encoded, OutputStream decoded, COSDictionary parameters, int index, DecodeOptions options) throws IOException Decodes data, with optional DecodeOptions. Not all filters support all options, and so callers should check the options' `honored` flag to test if they were applied. Parameters encoded:InputStream the encoded byte stream decoded:OutputStream the stream where decoded data will be written parameters:COSDictionary the parameters used for decoding index:int the index to the filter being decoded options:DecodeOptions additional options for decoding Returns:DecodeResult repaired parameters dictionary, or the original parameters dictionary Exceptions IOException: if the stream cannot be decoded

public DecodeResult decode(InputStream encoded, OutputStream decoded, COSDictionary parameters, int index, DecodeOptions options) throws IOException

Decodes data, with optional DecodeOptions. Not all filters support all options, and so callers should check the options' honored flag to test if they were applied.

Parameters

encoded:InputStream: the encoded byte stream
decoded:OutputStream: the stream where decoded data will be written
parameters:COSDictionary: the parameters used for decoding
index:int: the index to the filter being decoded
options:DecodeOptions: additional options for decoding

Returns:DecodeResult

repaired parameters dictionary, or the original parameters dictionary

Exceptions

IOException:: if the stream cannot be decoded

decode back to summary

decode	back to summary
public static RandomAccessRead decode(InputStream encoded, List<Filter> filterList, COSDictionary parameters, DecodeOptions options, List<DecodeResult> results) throws IOException Decodes data, with optional DecodeOptions. Not all filters support all options, and so callers should check the options' `honored` flag to test if they were applied. Parameters encoded:InputStream the input stream holding the encoded data filterList:List<Filter> list of filters to be used for decoding parameters:COSDictionary the parameters used for decoding options:DecodeOptions additional options for decoding results:List<DecodeResult> list of optional decoding results for each filter Returns:RandomAccessRead the decoded stream data Exceptions IOException: if the stream cannot be decoded IllegalArgumentException: if filterList is empty

public static RandomAccessRead decode(InputStream encoded, List<Filter> filterList, COSDictionary parameters, DecodeOptions options, List<DecodeResult> results) throws IOException

Decodes data, with optional DecodeOptions. Not all filters support all options, and so callers should check the options' honored flag to test if they were applied.

Parameters

encoded:InputStream: the input stream holding the encoded data
filterList:List<Filter>: list of filters to be used for decoding
parameters:COSDictionary: the parameters used for decoding
options:DecodeOptions: additional options for decoding
results:List<DecodeResult>: list of optional decoding results for each filter

Returns:RandomAccessRead

the decoded stream data

Exceptions

IOException:: if the stream cannot be decoded
IllegalArgumentException:: if filterList is empty

encode	back to summary
public final void encode(InputStream input, OutputStream encoded, COSDictionary parameters, int index) throws IOException Encodes data. Parameters input:InputStream the byte stream to encode encoded:OutputStream the stream where encoded data will be written parameters:COSDictionary the parameters used for encoding index:int the index to the filter being encoded Exceptions IOException: if the stream cannot be encoded

encode

back to summary

public final void encode(InputStream input, OutputStream encoded, COSDictionary parameters, int index) throws IOException

Encodes data.

Parameters

input:InputStream: the byte stream to encode
encoded:OutputStream: the stream where encoded data will be written
parameters:COSDictionary: the parameters used for encoding
index:int: the index to the filter being encoded

Exceptions

IOException:: if the stream cannot be encoded

encode	back to summary
protected abstract void encode(InputStream input, OutputStream encoded, COSDictionary parameters) throws IOException

findImageReader	back to summary
public static final ImageReader findImageReader(String formatName, String errorCause) throws MissingImageReaderException Finds a suitable image reader for an image format. Parameters formatName:String The image format to search for. errorCause:String The probably cause if something goes wrong. Returns:ImageReader The image reader for the format. Exceptions MissingImageReaderException: if no image reader is found.

findImageReader

back to summary

public static final ImageReader findImageReader(String formatName, String errorCause) throws MissingImageReaderException

Finds a suitable image reader for an image format.

Parameters

formatName:String: The image format to search for.
errorCause:String: The probably cause if something goes wrong.

Returns:ImageReader

The image reader for the format.

Exceptions

MissingImageReaderException:: if no image reader is found.

findRasterReader	back to summary
public static final ImageReader findRasterReader(String formatName, String errorCause) throws MissingImageReaderException Finds a suitable image raster reader for an image format. Parameters formatName:String The image format to search for. errorCause:String The probably cause if something goes wrong. Returns:ImageReader The image reader for the format. Exceptions MissingImageReaderException: if no image reader is found.

findRasterReader

back to summary

public static final ImageReader findRasterReader(String formatName, String errorCause) throws MissingImageReaderException

Finds a suitable image raster reader for an image format.

Parameters

formatName:String: The image format to search for.
errorCause:String: The probably cause if something goes wrong.

Returns:ImageReader

The image reader for the format.

Exceptions

MissingImageReaderException:: if no image reader is found.

getCompressionLevel	back to summary
public static int getCompressionLevel() Returns:int the ZIP compression level configured for PDFBox

getDecodeParams	back to summary
protected COSDictionary getDecodeParams(COSDictionary dictionary, int index)

public abstract Class Filter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail