com.ajtjp.jImageReader.reader

Class BaseImageReader

java.lang.Object

javax.imageio.ImageReader

com.ajtjp.jImageReader.reader.BaseImageReader

Direct Known Subclasses:

AwardBIOSReader, DrHaloReader, EggPaintReader, GodPaintReader, MegaPaintBLDReader, MSPReader

public abstract class BaseImageReader
extends ImageReader

Base class for "common"/shared image reader tasks. Contains both common code for general bitmap-based file formats, as well as defaults for ImageIO ImageReader methods where the implementation will not vary between most formats.

Author:

Andrew

Field Summary

Fields inherited from class javax.imageio.ImageReader

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseImageReader(ImageReaderSpi originatingProvider)

Method Summary

Modifier and Type	Method and Description
void	createBufferedImage() Creates a BufferedImage from the image, based on a parsed internal representation.
int	getHeight() Returns the height of the image in pixels.
int	getHeight(int imageIndex)
BufferedImage	getImage() Returns the BufferedImage that has been created from this ImageReader.
IIOMetadata	getImageMetadata(int imageIndex)
Iterator<ImageTypeSpecifier>	getImageTypes(int imageIndex)
int	getNumImages(boolean allowSearch)
IIOMetadata	getStreamMetadata()
int	getWidth() Returns the width of the image in pixels.
int	getWidth(int imageIndex)
protected abstract void	parse() Parses the image from the internal buffer, to an internal representation.
void	processFile() Reads and parses a file, and stores a BufferedImage; this is the method you will use most often.
BufferedImage	read(int imageIndex, ImageReadParam ignored)
void	readFile(File file) Reads the image from a file, and stores it in an internal buffer.
void	readFile(ImageInputStream iis) Reads the image from an ImageInputStream into an internal buffer.

Methods inherited from class javax.imageio.ImageReader

abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, canReadRaster, checkReadParamBandSettings, clearAbortRequest, computeRegions, dispose, getAspectRatio, 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 Detail

BaseImageReader

protected BaseImageReader(ImageReaderSpi originatingProvider)

Method Detail

parse

protected abstract void parse()
                       throws IllegalDataException

Parses the image from the internal buffer, to an internal representation. This internal representation may (and likely will) have format-specific information, which may be useful to consuming programs for some formats. If you wish to have a consumable image, you will also need to call createBufferedImage.

Throws:

IllegalDataException - If parsing cannot be completed due to illegal data.

getImage

public BufferedImage getImage()

Returns the BufferedImage that has been created from this ImageReader. Requires that either processFile, or the combination of readFile, parse, and createBufferedImage has been called first.

Returns:

The image created by this reader.

processFile

public void processFile()
                 throws IllegalDataException,
                        UnsupportedVariantException

Reads and parses a file, and stores a BufferedImage; this is the method you will use most often.

Throws:

IllegalDataException - If illegal data is encountered.

UnsupportedVariantException - If an unsupported variant of the image format is encountered.

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

getWidth

public int getWidth()

Returns the width of the image in pixels.

Returns:

The width of the image.

getHeight

public int getHeight()

Returns the height of the image in pixels.

Returns:

The height of the image.

readFile

public void readFile(File file)

Reads the image from a file, and stores it in an internal buffer. This does not parse the image; that is handled by the parse method. This method is implemented in the base class, and generally will not have to be overridden by implementing sub-classes.

Parameters:

file - The file to be read.

createBufferedImage

public void createBufferedImage()

Creates a BufferedImage from the image, based on a parsed internal representation. The readFile and parse methods must be called prior to this one. If the internal representation uses the provided bitmap to store its raw copy of the image, this will not have to be overridden by an implementing sub-class.

getImageTypes

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

Specified by:

getImageTypes in class ImageReader

Throws:

IOException

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 ignored)

Specified by:

read in class ImageReader

readFile

public void readFile(ImageInputStream iis)

Reads the image from an ImageInputStream into an internal buffer. This does not parse the image; that is handled by the parse method. This method is implemented in the base class, and generally will not have to be overridden by implementing sub-classes.

Parameters:

iis - The ImageInputStream to be read.