Class PBMImageReader

java.lang.Object

javax.imageio.ImageReader

org.monte.media.pbm.PBMImageReader

All Implemented Interfaces:

AnimatedImageReader

public class PBMImageReader
extends ImageReader
implements AnimatedImageReader

Reads an image in the Amiga IFF Packed Bitmap image format (PBM).

Author:

Werner Randelshofer

Field Summary

Fields inherited from class javax.imageio.ImageReader

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

Constructor Summary

Constructors

Constructor	Description
PBMImageReader(PBMImageReaderSpi originatingProvider)

Method Summary

Modifier and Type	Method	Description
float	getAspectRatio(int imageIndex)	Returns the aspect ratio of the given image (that is, its width divided by its height) as a float.
int	getHeight(int imageIndex)
IIOMetadata	getImageMetadata(int imageIndex)
Iterator<ImageTypeSpecifier>	getImageTypes(int imageIndex)
int	getNumImages(boolean allowSearch)
IIOMetadata	getStreamMetadata()
int	getWidth(int imageIndex)
BufferedImage	read(int imageIndex, ImageReadParam param)
Image	readAnimatedImage(int imageIndex)

Methods inherited from class javax.imageio.ImageReader

abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, canReadRaster, checkReadParamBandSettings, clearAbortRequest, computeRegions, dispose, getAvailableLocales, getDefaultReadParam, 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, readRaster, readThumbnail, readTile, readTileRaster, removeAllIIOReadProgressListeners, removeAllIIOReadUpdateListeners, removeAllIIOReadWarningListeners, removeIIOReadProgressListener, removeIIOReadUpdateListener, removeIIOReadWarningListener, reset, setInput, setInput, setInput, setLocale

Methods inherited from class java.lang.Object

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

Constructor Details

PBMImageReader

public PBMImageReader(PBMImageReaderSpi originatingProvider)

Method Details

getNumImages

public int getNumImages(boolean allowSearch)
                 throws IOException

Specified by:

getNumImages in class ImageReader

Throws:

IOException

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

getImageTypes

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

Specified by:

getImageTypes in class ImageReader

Throws:

IOException

getAspectRatio

public float getAspectRatio(int imageIndex)
                     throws IOException

Returns the aspect ratio of the given image (that is, its width divided by its height) as a float. For images that are inherently resizable, this method provides a way to determine the appropriate width given a deired height, or vice versa. For non-resizable images, the true width and height are used.

The default implementation simply returns (float)getWidth(imageIndex)/getHeight(imageIndex).

Overrides:

getAspectRatio in class ImageReader

Parameters:

imageIndex - the index of the image to be queried.

Returns:

a float indicating the aspect ratio of the given image.

Throws:

IllegalStateException - if the input source has not been set.

IndexOutOfBoundsException - if the supplied index is out of bounds.

IOException - if an error occurs during reading.

getStreamMetadata

public IIOMetadata getStreamMetadata()
                              throws IOException

Specified by:

getStreamMetadata in class ImageReader

Throws:

IOException

getImageMetadata

public IIOMetadata getImageMetadata(int imageIndex)
                             throws IOException

Specified by:

getImageMetadata in class ImageReader

Throws:

IOException

read

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

Specified by:

read in class ImageReader

Throws:

IOException

readAnimatedImage

public Image readAnimatedImage(int imageIndex)
                        throws IOException

Specified by:

readAnimatedImage in interface AnimatedImageReader

Throws:

IOException