Package org.apache.xmlgraphics.image.codec.tiff

Class TIFFImageEncoder

java.lang.Object

org.apache.xmlgraphics.image.codec.util.ImageEncoderImpl

org.apache.xmlgraphics.image.codec.tiff.TIFFImageEncoder

All Implemented Interfaces:

ImageEncoder

public class TIFFImageEncoder
extends ImageEncoderImpl

A baseline TIFF writer. The writer outputs TIFF images in either Bilevel, Greyscale, Palette color or Full Color modes.

Field Summary

Fields inherited from class org.apache.xmlgraphics.image.codec.util.ImageEncoderImpl

output, param

Constructor Summary

Constructors

Constructor	Description
TIFFImageEncoder(OutputStream output, ImageEncodeParam param)

Method Summary

Modifier and Type	Method	Description
void	encode(RenderedImage im)	Encodes a RenderedImage and writes the output to the OutputStream associated with this ImageEncoder.
Object	encodeMultiple(Object context, RenderedImage img)	Encodes a RenderedImage as part of a multi-page file and writes the output to the OutputStream associated with this ImageEncoder.
void	finishMultiple(Object context)	Signals the encoder that you've finished sending pages for a multi-page image files.

Methods inherited from class org.apache.xmlgraphics.image.codec.util.ImageEncoderImpl

encode, getOutputStream, getParam, setParam

Methods inherited from class java.lang.Object

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

Constructor Detail

TIFFImageEncoder

public TIFFImageEncoder(OutputStream output,
                        ImageEncodeParam param)

Method Detail

encode

public void encode(RenderedImage im)
            throws IOException

Encodes a RenderedImage and writes the output to the OutputStream associated with this ImageEncoder.

Specified by:

encode in interface ImageEncoder

Specified by:

encode in class ImageEncoderImpl

Throws:

IOException

encodeMultiple

public Object encodeMultiple(Object context,
                             RenderedImage img)
                      throws IOException

Encodes a RenderedImage as part of a multi-page file and writes the output to the OutputStream associated with this ImageEncoder.

When you sent all pages, make sure you call finishMultiple() in the end. Otherwise, the generated file will be corrupted.

Parameters:

context - the context object you receive as return value to a previous call to encodeMultiple(). Set null for the first image.

img - the image

Returns:

a context object needed for writing multiple pages for a single image file

Throws:

IOException - In case of an I/O error

finishMultiple

public void finishMultiple(Object context)
                    throws IOException

Signals the encoder that you've finished sending pages for a multi-page image files.

Parameters:

context - the context object you receive as return value to a previous call to encodeMultiple()

Throws:

IOException - In case of an I/O error