org.apache.pdfbox.jbig2

Class JBIG2ImageReader

java.lang.Object

javax.imageio.ImageReader

org.apache.pdfbox.jbig2.JBIG2ImageReader

public class JBIG2ImageReader
extends ImageReader

Field Summary

Fields inherited from class javax.imageio.ImageReader

availableLocales, ignoreMetadata, input, locale, minIndex, originatingProvider, progressListeners, seekForwardOnly, updateListeners, warningListeners, warningLocales

Constructor Summary

Constructors

Constructor and Description
JBIG2ImageReader(ImageReaderSpi originatingProvider)

Method Summary

Modifier and Type	Method and Description
boolean	canReadRaster()
JBIG2ReadParam	getDefaultReadParam()
JBIG2Globals	getGlobals() Returns decoded segments that has been set as globals.
int	getHeight(int imageIndex)
IIOMetadata	getImageMetadata(int imageIndex)
Iterator<ImageTypeSpecifier>	getImageTypes(int imageIndex)
int	getNumImages(boolean allowSearch)
IIOMetadata	getStreamMetadata() This ImageIO plugin doesn't record IIOMetadata.
int	getWidth(int imageIndex)
JBIG2Globals	processGlobals(ImageInputStream globalsInputStream) Decodes and returns the global segments.
BufferedImage	read(int imageIndex, ImageReadParam param)
Raster	readRaster(int imageIndex, ImageReadParam param)
void	setGlobals(JBIG2Globals globals) Simply sets the globals.
void	setInput(Object input, boolean seekForwardOnly, boolean ignoreMetadata)

Methods inherited from class javax.imageio.ImageReader

abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, checkReadParamBandSettings, clearAbortRequest, computeRegions, dispose, getAspectRatio, getAvailableLocales, getDestination, getFormatName, getImageMetadata, getInput, getLocale, getMinIndex, getNumThumbnails, getOriginatingProvider, getRawImageType, getSourceRegion, getStreamMetadata, getThumbnailHeight, getThumbnailWidth, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, hasThumbnails, isIgnoringMetadata, isImageTiled, isRandomAccessEasy, isSeekForwardOnly, processImageComplete, processImageProgress, processImageStarted, processImageUpdate, processPassComplete, processPassStarted, processReadAborted, processSequenceComplete, processSequenceStarted, processThumbnailComplete, processThumbnailPassComplete, processThumbnailPassStarted, processThumbnailProgress, processThumbnailStarted, processThumbnailUpdate, processWarningOccurred, processWarningOccurred, read, readAll, readAll, readAsRenderedImage, readerSupportsThumbnails, readThumbnail, readTile, readTileRaster, removeAllIIOReadProgressListeners, removeAllIIOReadUpdateListeners, removeAllIIOReadWarningListeners, removeIIOReadProgressListener, removeIIOReadUpdateListener, removeIIOReadWarningListener, reset, setInput, setInput, setLocale

Methods inherited from class java.lang.Object

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

Constructor Detail

JBIG2ImageReader

public JBIG2ImageReader(ImageReaderSpi originatingProvider)
                 throws IOException

Throws:

IOException - if something went wrong while reading the provided stream.

Method Detail

getDefaultReadParam

public JBIG2ReadParam getDefaultReadParam()

Overrides:

getDefaultReadParam in class ImageReader

getWidth

public int getWidth(int imageIndex)
             throws IOException

Specified by:

getWidth in class ImageReader

Throws:

IOException

getHeight

public int getHeight(int imageIndex)
              throws IOException

Specified by:

getHeight in class ImageReader

Throws:

IOException

getImageMetadata

public IIOMetadata getImageMetadata(int imageIndex)
                             throws IOException

Specified by:

getImageMetadata in class ImageReader

Throws:

IOException

getImageTypes

public Iterator<ImageTypeSpecifier> getImageTypes(int imageIndex)
                                           throws IOException

Specified by:

getImageTypes in class ImageReader

Throws:

IOException

getNumImages

public int getNumImages(boolean allowSearch)
                 throws IOException

Specified by:

getNumImages in class ImageReader

Throws:

IOException

getStreamMetadata

public IIOMetadata getStreamMetadata()

This ImageIO plugin doesn't record IIOMetadata.

Specified by:

getStreamMetadata in class ImageReader

Returns:

null at every call.

getGlobals

public JBIG2Globals getGlobals()
                        throws IOException

Returns decoded segments that has been set as globals. Globals are jbig2 segments that are used in embedded case for file wide access. They are not assigned to a specific page.

Returns:

Decoded global segments.

Throws:

IOException - if an error occurs reading the height information from the input source.

read

public BufferedImage read(int imageIndex,
                          ImageReadParam param)
                   throws IOException

Specified by:

read in class ImageReader

Throws:

IOException

canReadRaster

public boolean canReadRaster()

Overrides:

canReadRaster in class ImageReader

readRaster

public Raster readRaster(int imageIndex,
                         ImageReadParam param)
                  throws IOException

Overrides:

readRaster in class ImageReader

Throws:

IOException

processGlobals

public JBIG2Globals processGlobals(ImageInputStream globalsInputStream)
                            throws IOException

Decodes and returns the global segments.

Parameters:

globalsInputStream - - The input stream of globals data.

Returns:

The decoded JBIG2Globals.

Throws:

IOException - if an error occurs reading the height information from the input source.

setGlobals

public void setGlobals(JBIG2Globals globals)
                throws IOException

Simply sets the globals.

Parameters:

globals - - The globals to set.

Throws:

IOException - if an error occurs

setInput

public void setInput(Object input,
                     boolean seekForwardOnly,
                     boolean ignoreMetadata)

Overrides:

setInput in class ImageReader