Package com.tom_roush.pdfbox.filter

Class JPXFilter

java.lang.Object

com.tom_roush.pdfbox.filter.Filter

com.tom_roush.pdfbox.filter.JPXFilter

public final class JPXFilter
extends Filter

Decompress data encoded using the wavelet-based JPEG 2000 standard, reproducing the original data. Requires the JP2ForAndroid library to be available from com.gemalto.jp2:jp2-android:1.0.3, see JP2ForAndroid.

Field Summary

Fields inherited from class com.tom_roush.pdfbox.filter.Filter

SYSPROP_DEFLATELEVEL

Constructor Summary

Constructors

Constructor	Description
JPXFilter()

Method Summary

Modifier and Type	Method	Description
DecodeResult	decode(InputStream encoded, OutputStream decoded, COSDictionary parameters, int index)	Decodes data, producing the original non-encoded data.
DecodeResult	decode(InputStream encoded, OutputStream decoded, COSDictionary parameters, int index, DecodeOptions options)	Decodes data, with optional DecodeOptions.
protected void	encode(InputStream input, OutputStream encoded, COSDictionary parameters)

Methods inherited from class com.tom_roush.pdfbox.filter.Filter

encode, getCompressionLevel, getDecodeParams

Methods inherited from class java.lang.Object

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

Constructor Detail

JPXFilter

public JPXFilter()

Method Detail

decode

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.

Overrides:

decode in class Filter

Parameters:

encoded - the encoded byte stream

decoded - the stream where decoded data will be written

parameters - the parameters used for decoding

index - the index to the filter being decoded

options - additional options for decoding

Returns:

repaired parameters dictionary, or the original parameters dictionary

Throws:

IOException - if the stream cannot be decoded

decode

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

Description copied from class: Filter

Decodes data, producing the original non-encoded data.

Specified by:

decode in class Filter

Parameters:

encoded - the encoded byte stream

decoded - the stream where decoded data will be written

parameters - the parameters used for decoding

index - the index to the filter being decoded

Returns:

repaired parameters dictionary, or the original parameters dictionary

Throws:

IOException - if the stream cannot be decoded

encode

protected void encode(InputStream input,
                      OutputStream encoded,
                      COSDictionary parameters)
               throws IOException

Specified by:

encode in class Filter

Throws:

IOException