Use is subject to License Terms. Your use of this web site or any of its content or software indicates your agreement to be bound by these License Terms.

Copyright © 2006 Sun Microsystems, Inc. All rights reserved.

javax.imageio
Class IIOImage

java.lang.Object
  javax.imageio.IIOImage

public class IIOImage

extends java.lang.Object

A simple container class to aggregate an image.

The image data must take the form of a RenderedImage.

See Also:

ImageReader.readAll(java.util.Iterator), ImageWriter.write(javax.imageio.metadata.IIOMetadata, IIOImage, ImageWriteParam), ImageWriter.write(java.awt.image.RenderedImage)

Field Summary

protected RenderedImage

image The RenderedImage being referenced.

Constructor Summary

IIOImage(RenderedImage image, java.util.List thumbnails, IIOMetadata metadata)
Constructs an IIOImage containing a RenderedImage.

Method Summary

RenderedImage	getRenderedImage() Returns the currently set RenderedImage
void	setRenderedImage(RenderedImage image) Sets the current RenderedImage.

Methods inherited from class java.lang.Object

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

Field Detail

image

protected RenderedImage image

The RenderedImage being referenced.

Constructor Detail

IIOImage

public IIOImage(RenderedImage image,
                java.util.List thumbnails,
                IIOMetadata metadata)

Constructs an IIOImage containing a RenderedImage.

All parameters are stored by reference.

The thumbnails argument must be null. Any value other than null will throw an IllegalArgumentException.

The metadata argument must be null. Any value other than null will throw an IllegalArgumentException.

Parameters:

image - a RenderedImage.

thumbnails - must be null.

metadata - must be null.

Throws:

java.lang.IllegalArgumentException - if image is null or not a BufferedImage. See restriction on RenderedImage.

java.lang.IllegalArgumentException - if thumbnails is not null.

java.lang.IllegalArgumentException - if metadata is not null.

Method Detail

getRenderedImage

public RenderedImage getRenderedImage()

Returns the currently set RenderedImage

Returns:

a RenderedImage, or null.

See Also:

setRenderedImage(java.awt.image.RenderedImage)

setRenderedImage

public void setRenderedImage(RenderedImage image)

Sets the current RenderedImage. The value is stored by reference.

Parameters:

image - a RenderedImage.

Throws:

java.lang.IllegalArgumentException - if image is null or not a BufferedImage. See restriction on RenderedImage

See Also:

getRenderedImage()