Class PNMImageReader

java.lang.Object

javax.imageio.ImageReader

com.github.jaiimageio.impl.plugins.pnm.PNMImageReader

public class PNMImageReader
extends ImageReader

This class is the Java Image IO plugin reader for PNM images. It may subsample the image, clip the image, select sub-bands, and shift the decoded image origin if the proper decoding parameter are set in the provided PNMImageReadParam.

Field Summary

Fields

Modifier and Type	Field	Description
private String	aLine
private boolean	gotHeader	Indicates whether the header is read.
private int	height	The original image height.
private ImageInputStream	iis	The input stream where reads from
private long	imageDataOffset	The stream position where the image data starts.
private static final int	LINE_FEED
private static byte[]	lineSeparator
private int	maxValue	Maximum pixel value.
private PNMMetadata	metadata
private static final int	PBM_ASCII
private static final int	PBM_RAW
private static final int	PGM_ASCII
private static final int	PGM_RAW
private static final int	PPM_ASCII
private static final int	PPM_RAW
private StringTokenizer	token
private int	variant	File variant: PBM/PGM/PPM, ASCII/RAW.
private int	width	The original image width.

Fields inherited from class ImageReader

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

Constructor Summary

Constructors

Constructor	Description
PNMImageReader(ImageReaderSpi originator)	Constructs PNMImageReader from the provided ImageReaderSpi.

Method Summary

Modifier and Type	Method	Description
boolean	canReadRaster()
private void	checkIndex(int imageIndex)
ImageReadParam	getDefaultReadParam()
int	getHeight(int imageIndex)
IIOMetadata	getImageMetadata(int imageIndex)
Iterator	getImageTypes(int imageIndex)
int	getMaxValue()
int	getNumImages(boolean allowSearch)	Overrides the method defined in the superclass.
IIOMetadata	getStreamMetadata()
int	getVariant()
int	getWidth(int imageIndex)
boolean	isRandomAccessEasy(int imageIndex)
private boolean	isRaw(int v)	Returns true if file variant is raw format, false if ASCII.
BufferedImage	read(int imageIndex, ImageReadParam param)
private void	readComments(ImageInputStream stream, PNMMetadata metadata)	Reads the comments.
void	readHeader()
private int	readInteger(ImageInputStream stream)	Reads the next integer.
Raster	readRaster(int imageIndex, ImageReadParam param)
void	reset()
void	setInput(Object input, boolean seekForwardOnly, boolean ignoreMetadata)	Overrides the method defined in the superclass.
private void	skipInteger(ImageInputStream stream, int num)

Methods inherited from class 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, 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, setInput, setInput, setLocale

Methods inherited from class Object

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

Field Details

PBM_ASCII

private static final int PBM_ASCII

See Also:

• Constant Field Values

PGM_ASCII

private static final int PGM_ASCII

See Also:

• Constant Field Values

PPM_ASCII

private static final int PPM_ASCII

See Also:

• Constant Field Values

PBM_RAW

private static final int PBM_RAW

See Also:

• Constant Field Values

PGM_RAW

private static final int PGM_RAW

See Also:

• Constant Field Values

PPM_RAW

private static final int PPM_RAW

See Also:

• Constant Field Values

LINE_FEED

private static final int LINE_FEED

See Also:

• Constant Field Values

lineSeparator

private static byte[] lineSeparator

variant

private int variant

File variant: PBM/PGM/PPM, ASCII/RAW.

maxValue

private int maxValue

Maximum pixel value.

iis

private ImageInputStream iis

The input stream where reads from

gotHeader

private boolean gotHeader

Indicates whether the header is read.

imageDataOffset

private long imageDataOffset

The stream position where the image data starts.

width

private int width

The original image width.

height

private int height

The original image height.

aLine

private String aLine

token

private StringTokenizer token

metadata

private PNMMetadata metadata

Constructor Details

PNMImageReader

public PNMImageReader(ImageReaderSpi originator)

Constructs PNMImageReader from the provided ImageReaderSpi.

Method Details

setInput

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

Overrides the method defined in the superclass.

Overrides:

setInput in class ImageReader

getNumImages

public int getNumImages(boolean allowSearch)
                 throws IOException

Overrides the method defined in the superclass.

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

getVariant

public int getVariant()

getMaxValue

public int getMaxValue()

checkIndex

private void checkIndex(int imageIndex)

readHeader

public void readHeader()
                throws IOException

Throws:

IOException

getImageTypes

public Iterator getImageTypes(int imageIndex)
                       throws IOException

Specified by:

getImageTypes in class ImageReader

Throws:

IOException

getDefaultReadParam

public ImageReadParam getDefaultReadParam()

Overrides:

getDefaultReadParam in class ImageReader

getImageMetadata

public IIOMetadata getImageMetadata(int imageIndex)
                             throws IOException

Specified by:

getImageMetadata in class ImageReader

Throws:

IOException

getStreamMetadata

public IIOMetadata getStreamMetadata()
                              throws IOException

Specified by:

getStreamMetadata in class ImageReader

Throws:

IOException

isRandomAccessEasy

public boolean isRandomAccessEasy(int imageIndex)
                           throws IOException

Overrides:

isRandomAccessEasy in class ImageReader

Throws:

IOException

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

reset

public void reset()

Overrides:

reset in class ImageReader

isRaw

private boolean isRaw(int v)

Returns true if file variant is raw format, false if ASCII.

readComments

private void readComments(ImageInputStream stream,
 PNMMetadata metadata)
                   throws IOException

Reads the comments.

Throws:

IOException

readInteger

private int readInteger(ImageInputStream stream)
                 throws IOException

Reads the next integer.

Throws:

IOException

skipInteger

private void skipInteger(ImageInputStream stream,
 int num)
                  throws IOException

Throws:

IOException