javax.imageio

Class ImageWriter

public abstract class ImageWriter extends Object implements ImageTranscoder

A class for encoding images within the ImageIO framework. An ImageWriter for a given format is instantiated by an ImageWriterSpi for that format. ImageWriterSpis are registered with the IIORegistry. The ImageWriter API supports writing animated images that may have multiple frames; to support such images many methods take an index parameter. Images may also be written in multiple passes, where each successive pass increases the level of detail in the destination image.

Field Summary
protected Locale[]	availableLocales All locales available for localization of warning messages, or null if localization is not supported.
protected Locale	locale The current locale used to localize warning messages, or null if no locale has been set.
protected ImageWriterSpi	originatingProvider The image writer SPI that instantiated this writer.
protected Object	output An ImageInputStream to which image data is written.
protected List<IIOWriteProgressListener>	progressListeners A list of installed progress listeners.
protected List<IIOWriteWarningListener>	warningListeners A list of installed warning listeners.
protected List<Locale>	warningLocales A list of warning locales corresponding with the list of installed warning listeners.

Constructor Summary
protected	ImageWriter(ImageWriterSpi originatingProvider) Construct an image writer.

Method Summary
void	abort() Request that writing be aborted.
protected boolean	abortRequested() Check if the abort flag is set.
void	addIIOWriteProgressListener(IIOWriteProgressListener listener) Install a write progress listener.
void	addIIOWriteWarningListener(IIOWriteWarningListener listener) Install a write warning listener.
boolean	canInsertEmpty(int imageIndex) Check whether a new empty image can be inserted at the given frame index.
boolean	canInsertImage(int imageIndex) Check whether an image can be inserted at the given frame index.
boolean	canRemoveImage(int imageIndex) Check whether an image can be removed from the given frame index.
boolean	canReplaceImageMetadata(int imageIndex) Check whether the metadata associated the image at the given frame index can be replaced.
boolean	canReplacePixels(int imageIndex) Check whether the pixels within the image at the given index can be replaced.
boolean	canReplaceStreamMetadata() Check whether the metadata associated the entire image stream can be replaced.
boolean	canWriteEmpty() Check whether an entire empty image, including empty metadata and empty thumbnails, can be written to the output stream, leaving pixel values to be filled in later using the replacePixels methods.
boolean	canWriteRasters() Check if IIOImages containing raster data are supported.
boolean	canWriteSequence() Check if an image can be appended at the end of the current list of images even if prior images have already been written.
protected void	clearAbortRequest() Clear the abort flag.
abstract IIOMetadata	convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param) Convert IIOMetadata from an input reader format, returning an IIOMetadata suitable for use by an image writer.
abstract IIOMetadata	convertStreamMetadata(IIOMetadata inData, ImageWriteParam param) Convert IIOMetadata from an input stream format, returning an IIOMetadata suitable for use by an image writer.
void	dispose() Releases any resources allocated to this object.
void	endInsertEmpty() Complete inserting an empty image in the output stream.
void	endReplacePixels() Complete replacing pixels in an image in the output stream.
void	endWriteEmpty() Complete writing an empty image to the image output stream.
void	endWriteSequence() Complete writing a sequence of images to the output stream.
Locale[]	getAvailableLocales() Retrieve the available locales.
abstract IIOMetadata	getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param) Get a metadata object appropriate for encoding an image specified by the given image type specifier and optional image write parameters.
abstract IIOMetadata	getDefaultStreamMetadata(ImageWriteParam param) Get a metadata object appropriate for encoding the default image type handled by this writer, optionally considering image write parameters.
ImageWriteParam	getDefaultWriteParam() Retrieve the default write parameters for this writer's image format.
Locale	getLocale() Get this writer's locale. null is returned if the locale has not been set.
int	getNumThumbnailsSupported(ImageTypeSpecifier imageType, ImageWriteParam param, IIOMetadata streamMetadata, IIOMetadata imageMetadata) Get the number of thumbnails supported by this image writer, based on the given image type, image writing parameters, and stream and image metadata.
ImageWriterSpi	getOriginatingProvider() Get the ImageWriterSpi that created this writer or null.
Object	getOutput() Get this reader's image output destination. null is returned if the image destination has not been set.
Dimension[]	getPreferredThumbnailSizes(ImageTypeSpecifier imageType, ImageWriteParam param, IIOMetadata streamMetadata, IIOMetadata imageMetadata) Get the preferred sizes for thumbnails based on the given image type, image writing parameters, and stream and image metadata.
void	prepareInsertEmpty(int imageIndex, ImageTypeSpecifier imageType, int width, int height, IIOMetadata imageMetadata, List<? extends BufferedImage> thumbnails, ImageWriteParam param) Start inserting an empty image in the image output stream.
void	prepareReplacePixels(int imageIndex, Rectangle region) Start the replacement of pixels within an image in the output stream.
void	prepareWriteEmpty(IIOMetadata streamMetadata, ImageTypeSpecifier imageType, int width, int height, IIOMetadata imageMetadata, List<? extends BufferedImage> thumbnails, ImageWriteParam param) Start writing an empty image to the end of the image output stream.
void	prepareWriteSequence(IIOMetadata streamMetadata) Start the writing of a sequence of images.
protected void	processImageComplete() Notifies all installed write progress listeners that image loading has completed by calling their imageComplete methods.
protected void	processImageProgress(float percentageDone) Notifies all installed write progress listeners that a certain percentage of the image has been loaded, by calling their imageProgress methods.
protected void	processImageStarted(int imageIndex) Notifies all installed write progress listeners, by calling their imageStarted methods, that image loading has started on the given image.
protected void	processThumbnailComplete() Notifies all installed write progress listeners, by calling their thumbnailComplete methods, that a thumbnail has completed loading.
protected void	processThumbnailProgress(float percentageDone) Notifies all installed write progress listeners that a certain percentage of a thumbnail has been loaded, by calling their thumbnailProgress methods.
protected void	processThumbnailStarted(int imageIndex, int thumbnailIndex) Notifies all installed write progress listeners, by calling their imageStarted methods, that thumbnail loading has started on the given thumbnail of the given image.
protected void	processWarningOccurred(int imageIndex, String warning) Notifies all installed warning listeners, by calling their warningOccurred methods, that a warning message has been raised.
protected void	processWarningOccurred(int imageIndex, String baseName, String keyword) Notify all installed warning listeners, by calling their warningOccurred methods, that a warning message has been raised.
protected void	processWriteAborted() Notifies all installed write progress listeners that image loading has been aborted by calling their writeAborted methods.
void	removeAllIIOWriteProgressListeners() Uninstall all write progress listeners.
void	removeAllIIOWriteWarningListeners() Uninstall all write warning listeners.
void	removeIIOWriteProgressListener(IIOWriteProgressListener listener) Uninstall the given write progress listener.
void	removeIIOWriteWarningListener(IIOWriteWarningListener listener) Uninstall the given write warning listener.
void	removeImage(int imageIndex) Remove the image at the specified index from the output stream.
void	replaceImageMetadata(int imageIndex, IIOMetadata imageMetadata) Replace the metadata associated with the image at the given index.
void	replacePixels(RenderedImage image, ImageWriteParam param) Replace a region of an image in the output stream with a portion of the given rendered image.
void	replacePixels(Raster raster, ImageWriteParam param) Replace a region of an image in the output stream with a portion of the given raster data.
void	replaceStreamMetadata(IIOMetadata streamMetadata) Replace the metadata associated with this image stream.
void	reset() Reset this writer's internal state.
void	setLocale(Locale locale) Set the current locale or use the default locale.
void	setOutput(Object output) Set the output destination of the given object.
abstract void	write(IIOMetadata streamMetadata, IIOImage image, ImageWriteParam param) Write an image stream, including thumbnails and metadata to the output stream.
void	write(RenderedImage image) Write a rendered image to the output stream.
void	write(IIOImage image) Write a image data, metadata and thumbnails to the output stream.
void	writeInsert(int imageIndex, IIOImage image, ImageWriteParam param) Insert an image into the output stream.
void	writeToSequence(IIOImage image, ImageWriteParam param) Write a sequence of images, including thumbnails and metadata, to the output stream.

Field Detail

availableLocales

protected Locale[] availableLocales

All locales available for localization of warning messages, or null if localization is not supported.

locale

protected Locale locale

The current locale used to localize warning messages, or null if no locale has been set.

originatingProvider

protected ImageWriterSpi originatingProvider

The image writer SPI that instantiated this writer.

output

protected Object output

An ImageInputStream to which image data is written.

progressListeners

protected List<IIOWriteProgressListener> progressListeners

A list of installed progress listeners. Initially null, meaning no installed listeners.

warningListeners

protected List<IIOWriteWarningListener> warningListeners

A list of installed warning listeners. Initially null, meaning no installed listeners.

warningLocales

protected List<Locale> warningLocales

A list of warning locales corresponding with the list of installed warning listeners. Initially null, meaning no locales.

Constructor Detail

ImageWriter

protected ImageWriter(ImageWriterSpi originatingProvider)

Construct an image writer.

Parameters: originatingProvider the provider that is constructing this image writer, or null

Method Detail

abort

public void abort()

Request that writing be aborted. The unwritten portions of the destination image will be undefined. Writers should clear the abort flag before starting a write operation, then poll it periodically during the write operation.

abortRequested

protected boolean abortRequested()

Check if the abort flag is set.

Returns: true if the current write operation should be aborted, false otherwise

addIIOWriteProgressListener

public void addIIOWriteProgressListener(IIOWriteProgressListener listener)

Install a write progress listener. This method will return immediately if listener is null.

Parameters: listener a write progress listener or null

addIIOWriteWarningListener

public void addIIOWriteWarningListener(IIOWriteWarningListener listener)

Install a write warning listener. This method will return immediately if listener is null. Warning messages sent to this listener will be localized using the current locale. If the current locale is null then this writer will select a sensible default.

Parameters: listener a write warning listener

canInsertEmpty

public boolean canInsertEmpty(int imageIndex)

Check whether a new empty image can be inserted at the given frame index. Pixel values may be filled in later using the replacePixels methods. Indices greater than the insertion index will be incremented. If imageIndex is -1, the image will be appended at the end of the current image list.