Package com.twelvemonkeys.imageio
Class ImageWriterBase
java.lang.Object
javax.imageio.ImageWriter
com.twelvemonkeys.imageio.ImageWriterBase
- All Implemented Interfaces:
ImageTranscoder
Abstract base class for image writers.
- Version:
- $Id: ImageWriterBase.java,v 1.0 Sep 24, 2007 12:22:28 AM haraldk Exp$
- Author:
- Harald Kuhr, last modified by $Author: haraldk$
-
Field Summary
FieldsFields inherited from class javax.imageio.ImageWriter
availableLocales, locale, originatingProvider, output, progressListeners, warningListeners, warningLocales
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ImageWriterBase
(ImageWriterSpi provider) Constructs anImageWriter
and sets itsoriginatingProvider
instance variable to the supplied value. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Makes sure output is set.convertStreamMetadata
(IIOMetadata inData, ImageWriteParam param) Returnsnull
void
dispose()
protected static BufferedImage
fakeAOI
(BufferedImage pImage, ImageWriteParam pParam) Utility method for getting the area of interest (AOI) of an image.protected static Image
fakeSubsampling
(Image pImage, ImageWriteParam pParam) Utility method for getting the subsampled image.Returnsnull
protected static Rectangle
getSourceRegion
(ImageWriteParam pParam, int pWidth, int pHeight) void
reset()
protected void
void
Methods inherited from class javax.imageio.ImageWriter
abort, abortRequested, addIIOWriteProgressListener, addIIOWriteWarningListener, canInsertEmpty, canInsertImage, canRemoveImage, canReplaceImageMetadata, canReplacePixels, canReplaceStreamMetadata, canWriteEmpty, canWriteRasters, canWriteSequence, clearAbortRequest, convertImageMetadata, endInsertEmpty, endReplacePixels, endWriteEmpty, endWriteSequence, getAvailableLocales, getDefaultImageMetadata, getDefaultWriteParam, getLocale, getNumThumbnailsSupported, getOriginatingProvider, getOutput, getPreferredThumbnailSizes, prepareInsertEmpty, prepareReplacePixels, prepareWriteEmpty, prepareWriteSequence, processImageComplete, processImageProgress, processImageStarted, processThumbnailComplete, processThumbnailProgress, processThumbnailStarted, processWarningOccurred, processWarningOccurred, processWriteAborted, removeAllIIOWriteProgressListeners, removeAllIIOWriteWarningListeners, removeIIOWriteProgressListener, removeIIOWriteWarningListener, removeImage, replaceImageMetadata, replacePixels, replacePixels, replaceStreamMetadata, setLocale, write, write, write, writeInsert, writeToSequence
-
Field Details
-
imageOutput
For convenience. Only set if the output is anImageInputStream
.- See Also:
-
-
Constructor Details
-
ImageWriterBase
Constructs anImageWriter
and sets itsoriginatingProvider
instance variable to the supplied value.Subclasses that make use of extensions should provide a constructor with signature
(ImageWriterSpi, Object)
in order to retrieve the extension object. If the extension object is unsuitable, anIllegalArgumentException
should be thrown.- Parameters:
provider
- theImageWriterSpi
that is constructing this object, ornull
.
-
-
Method Details
-
getFormatName
- Throws:
IOException
-
setOutput
- Overrides:
setOutput
in classImageWriter
-
assertOutput
protected void assertOutput()Makes sure output is set.- Throws:
IllegalStateException
- ifgetOutput() == null
.
-
dispose
public void dispose()- Overrides:
dispose
in classImageWriter
-
reset
public void reset()- Overrides:
reset
in classImageWriter
-
resetMembers
protected void resetMembers() -
getDefaultStreamMetadata
Returnsnull
- Specified by:
getDefaultStreamMetadata
in classImageWriter
- Parameters:
param
- ignored.- Returns:
null
.
-
convertStreamMetadata
Returnsnull
- Specified by:
convertStreamMetadata
in interfaceImageTranscoder
- Specified by:
convertStreamMetadata
in classImageWriter
- Parameters:
inData
- ignored.param
- ignored.- Returns:
null
.
-
getSourceRegion
-
fakeAOI
Utility method for getting the area of interest (AOI) of an image. The AOI is defined by theIIOParam.setSourceRegion(java.awt.Rectangle)
method.Note: If it is possible for the writer to write the AOI directly, such a method should be used instead, for efficiency.
- Parameters:
pImage
- the image to get AOI frompParam
- the param optionally specifying the AOI- Returns:
- a
BufferedImage
containing the area of interest (source region), or the original image, if no source region was set, orpParam
wasnull
-
fakeSubsampling
Utility method for getting the subsampled image. The subsampling is defined by theIIOParam.setSourceSubsampling(int, int, int, int)
method.NOTE: This method does not take the subsampling offsets into consideration.
Note: If it is possible for the writer to subsample directly, such a method should be used instead, for efficiency.
- Parameters:
pImage
- the image to subsamplepParam
- the param optionally specifying subsampling- Returns:
- an
Image
containing the subsampled image, or the original image, if no subsampling was specified, orpParam
wasnull
-