org.apache.xmlgraphics.image.writer.imageio
Class ImageIOImageWriter

java.lang.Object
  org.apache.xmlgraphics.image.writer.imageio.ImageIOImageWriter

All Implemented Interfaces:

java.util.EventListener, javax.imageio.event.IIOWriteWarningListener, ImageWriter

Direct Known Subclasses:

ImageIOJPEGImageWriter, ImageIOPNGImageWriter, ImageIOTIFFImageWriter

public class ImageIOImageWriter

extends java.lang.Object

implements ImageWriter, javax.imageio.event.IIOWriteWarningListener

ImageWriter implementation that uses Image I/O to write images.

Version:

$Id: ImageIOImageWriter.java 750418 2009-03-05 11:03:54Z vhennebert $

Constructor Summary

ImageIOImageWriter(java.lang.String mime)
Main constructor.

Method Summary

MultiImageWriter	createMultiImageWriter(java.io.OutputStream out) Creates a MultiImageWriter instance that lets you put multiple pages into a single file if the format supports it.
protected static javax.imageio.metadata.IIOMetadataNode	getChildNode(org.w3c.dom.Node n, java.lang.String name) Returns a specific metadata child node
protected javax.imageio.ImageWriteParam	getDefaultWriteParam(javax.imageio.ImageWriter iiowriter, java.awt.image.RenderedImage image, ImageWriterParams params) Returns the default write parameters for encoding the image.
java.lang.String	getMIMEType()
boolean	isFunctional()
boolean	supportsMultiImageWriter()
protected javax.imageio.metadata.IIOMetadata	updateMetadata(javax.imageio.metadata.IIOMetadata meta, ImageWriterParams params) Updates the metadata information based on the parameters to this writer.
void	warningOccurred(javax.imageio.ImageWriter source, int imageIndex, java.lang.String warning)
void	writeImage(java.awt.image.RenderedImage image, java.io.OutputStream out) Encodes an image and writes it to an OutputStream.
void	writeImage(java.awt.image.RenderedImage image, java.io.OutputStream out, ImageWriterParams params) Encodes an image and writes it to an OutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageIOImageWriter

public ImageIOImageWriter(java.lang.String mime)

Main constructor.

Parameters:

mime - the MIME type of the image format

Method Detail

writeImage

public void writeImage(java.awt.image.RenderedImage image,
                       java.io.OutputStream out)
                throws java.io.IOException

Description copied from interface: ImageWriter

Encodes an image and writes it to an OutputStream.

Specified by:

writeImage in interface ImageWriter

Parameters:

image - the image to be encoded

out - the OutputStream to write to

Throws:

java.io.IOException - In case of an /IO problem

See Also:

ImageWriter.writeImage(java.awt.image.RenderedImage, java.io.OutputStream)

writeImage

public void writeImage(java.awt.image.RenderedImage image,
                       java.io.OutputStream out,
                       ImageWriterParams params)
                throws java.io.IOException

Description copied from interface: ImageWriter

Encodes an image and writes it to an OutputStream.

Specified by:

writeImage in interface ImageWriter

Parameters:

image - the image to be encoded

out - the OutputStream to write to

params - a parameters object to customize the encoding.

Throws:

java.io.IOException - In case of an /IO problem

See Also:

ImageWriter.writeImage(java.awt.image.RenderedImage, java.io.OutputStream, ImageWriterParams)

getDefaultWriteParam

protected javax.imageio.ImageWriteParam getDefaultWriteParam(javax.imageio.ImageWriter iiowriter,
                                                             java.awt.image.RenderedImage image,
                                                             ImageWriterParams params)

Returns the default write parameters for encoding the image.

Parameters:

iiowriter - The IIO ImageWriter that will be used

image - the image to be encoded

params - the parameters for this writer instance

Returns:

the IIO ImageWriteParam instance

updateMetadata

protected javax.imageio.metadata.IIOMetadata updateMetadata(javax.imageio.metadata.IIOMetadata meta,
                                                            ImageWriterParams params)

Updates the metadata information based on the parameters to this writer.

Parameters:

meta - the metadata

params - the parameters

Returns:

the updated metadata

getChildNode

protected static javax.imageio.metadata.IIOMetadataNode getChildNode(org.w3c.dom.Node n,
                                                                     java.lang.String name)

Returns a specific metadata child node

Parameters:

n - the base node

name - the name of the child

Returns:

the requested child node

getMIMEType

public java.lang.String getMIMEType()

Specified by:

getMIMEType in interface ImageWriter

Returns:

the target MIME type supported by this ImageWriter

See Also:

ImageWriter.getMIMEType()

isFunctional

public boolean isFunctional()

Specified by:

isFunctional in interface ImageWriter

Returns:

true if the ImageWriter is expected to work properly in the current environment

See Also:

ImageWriter.isFunctional()

warningOccurred

public void warningOccurred(javax.imageio.ImageWriter source,
                            int imageIndex,
                            java.lang.String warning)

Specified by:

warningOccurred in interface javax.imageio.event.IIOWriteWarningListener

See Also:

IIOWriteWarningListener.warningOccurred( javax.imageio.ImageWriter, int, java.lang.String)

createMultiImageWriter

public MultiImageWriter createMultiImageWriter(java.io.OutputStream out)
                                        throws java.io.IOException

Description copied from interface: ImageWriter

Creates a MultiImageWriter instance that lets you put multiple pages into a single file if the format supports it.

Specified by:

createMultiImageWriter in interface ImageWriter

Parameters:

out - the OutputStream to write the image to

Returns:

the requested MultiImageWriter instance

Throws:

java.io.IOException - In case of an /IO problem

See Also:

ImageWriter.createMultiImageWriter( java.io.OutputStream)

supportsMultiImageWriter

public boolean supportsMultiImageWriter()

Specified by:

supportsMultiImageWriter in interface ImageWriter

Returns:

true if the implemented format supports multiple pages in a single file

See Also:

ImageWriter.supportsMultiImageWriter()