org.apache.xmlgraphics.image.writer
Interface ImageWriter

All Known Implementing Classes:

AbstractImageWriter, ImageIOImageWriter

public interface ImageWriter

Interface which allows image library independent image writing.

Version:

$Id: ImageWriter.java 734420 2009-01-14 15:38:32Z maxberger $

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.
java.lang.String	getMIMEType()
boolean	isFunctional()
boolean	supportsMultiImageWriter()
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.

Method Detail

writeImage

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

Encodes an image and writes it to an OutputStream.

Parameters:

image - the image to be encoded

out - the OutputStream to write to

Throws:

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

writeImage

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

Encodes an image and writes it to an OutputStream.

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

getMIMEType

public java.lang.String getMIMEType()

Returns:

the target MIME type supported by this ImageWriter

isFunctional

public boolean isFunctional()

Returns:

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

supportsMultiImageWriter

public boolean supportsMultiImageWriter()

Returns:

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

createMultiImageWriter

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

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

Parameters:

out - the OutputStream to write the image to

Returns:

the requested MultiImageWriter instance

Throws:

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