Top Description Fields Constructors Methods
org.apache.pdfbox.filter

pack-priv final Class JBIG2Filter

extends Filter
Class Inheritance
Imports
java.awt.Graphics, java.awt.image.BufferedImage, .DataBuffer, .DataBufferByte, java.io.IOException, .InputStream, .OutputStream, .SequenceInputStream, javax.imageio.ImageIO, .ImageReadParam, .ImageReader, javax.imageio.stream.ImageInputStream, org.apache.commons.logging.Log, .LogFactory, org.apache.pdfbox.cos.COSDictionary, .COSName, .COSStream
Decompresses data encoded using the JBIG2 standard, reproducing the original monochrome (1 bit per pixel) image data (or an approximation of that data). Requires a JBIG2 plugin for Java Image I/O to be installed. A known working plug-in is the Apache PDFBox JBIG2 plugin.
Author
Timo Boehme

Field Summary

Modifier and TypeField and Description
private static boolean
levigoLogged

private static final Log
LOG

Hides org.apache.pdfbox.filter.Filter.LOG.

Inherited from org.apache.pdfbox.filter.Filter:
SYSPROP_DEFLATELEVEL

Constructor Summary

AccessConstructor and Description
pack-priv
JBIG2Filter()

Method Summary

Modifier and TypeMethod and Description
public DecodeResult
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)

Overrides org.apache.pdfbox.filter.Filter.decode.

Decodes data, with optional DecodeOptions.

public DecodeResult
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)

Implements abstract org.apache.pdfbox.filter.Filter.decode.

Decodes data, producing the original non-encoded data.

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

Implements abstract org.apache.pdfbox.filter.Filter.encode.

private static synchronized void
logLevigoDonated()

Inherited from org.apache.pdfbox.filter.Filter:
decodeencodefindImageReaderfindRasterReadergetCompressionLevelgetDecodeParams

Field Detail

levigoLoggedback to summary
private static boolean levigoLogged
LOGback to summary
private static final Log LOG

Hides org.apache.pdfbox.filter.Filter.LOG.

Constructor Detail

JBIG2Filterback to summary
pack-priv JBIG2Filter()

Method Detail

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

Overrides org.apache.pdfbox.filter.Filter.decode.

Doc from org.apache.pdfbox.filter.Filter.decode.

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

Annotations
@Override
Exceptions
IOException:
if the stream cannot be decoded
decodeback to summary
public DecodeResult decode(InputStream encoded, OutputStream decoded, COSDictionary parameters, int index) throws IOException

Implements abstract org.apache.pdfbox.filter.Filter.decode.

Doc from org.apache.pdfbox.filter.Filter.decode.

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

Annotations
@Override
Exceptions
IOException:
if the stream cannot be decoded
encodeback to summary
protected void encode(InputStream input, OutputStream encoded, COSDictionary parameters) throws IOException

Implements abstract org.apache.pdfbox.filter.Filter.encode.

Annotations
@Override
logLevigoDonatedback to summary
private static synchronized void logLevigoDonated()