IIOImage JDK 1.6)

Description

public class IIOImage

A simple container class to aggregate an image, a set of thumbnail (preview) images, and an object representing metadata associated with the image.

See also: ImageReader.readAll(int, ImageReadParam) ImageReader.readAll(java.util.Iterator)

ImageWriter.write(javax.imageio.metadata.IIOMetadata,
                        IIOImage, ImageWriteParam)

ImageWriter.write(IIOImage) ImageWriter.writeToSequence(IIOImage, ImageWriteParam) ImageWriter.writeInsert(int, IIOImage, ImageWriteParam)

Constructors

public IIOImage (Raster raster, List<BufferedImage> thumbnails, IIOMetadata metadata)

Constructs an IIOImage containing a Raster, and thumbnails and metadata associated with it.

All parameters are stored by reference.
Parameters:
- raster - a Raster.
- thumbnails - a List of BufferedImages, or null.
- metadata - an IIOMetadata object, or null.
Throws:
- IllegalArgumentException - if raster is null.

public IIOImage (RenderedImage image, List<BufferedImage> thumbnails, IIOMetadata metadata)

Constructs an IIOImage containing a RenderedImage, and thumbnails and metadata associated with it.

All parameters are stored by reference.

The thumbnails argument must either be null or contain only BufferedImage objects.
Parameters:
- image - a RenderedImage.
- thumbnails - a List of BufferedImages, or null.
- metadata - an IIOMetadata object, or null.
Throws:
- IllegalArgumentException - if image is null.

Methods

Hide/Show inherited methods

public IIOMetadata getMetadata ()

Returns a reference to the current IIOMetadata object, or null is none is set.

Returns a reference to the current IIOMetadata
object, or null is none is set.
Returns: an IIOMetadata object, or null.
See Also: IIOImage.setMetadata(javax.imageio.metadata.IIOMetadata),

public int getNumThumbnails ()

Returns the number of thumbnails stored in this IIOImage.

Returns the number of thumbnails stored in this
IIOImage.
Returns: the number of thumbnails, as an int.

public Raster getRaster ()

Returns the currently set Raster, or null if only a RenderedImage is available.

Returns the currently set Raster, or
null if only a RenderedImage is
available.
Returns: a Raster, or null.
See Also: IIOImage.setRaster(java.awt.image.Raster),

public RenderedImage getRenderedImage ()

Returns the currently set RenderedImage, or null if only a Raster is available.

Returns the currently set RenderedImage, or
null if only a Raster is available.
Returns: a RenderedImage, or null.
See Also: IIOImage.setRenderedImage(java.awt.image.RenderedImage),

public BufferedImage getThumbnail (int index)

Returns a thumbnail associated with the main image.

Returns a thumbnail associated with the main image.
Returns: a thumbnail image, as a BufferedImage.
Parameters:
- index - the index of the desired thumbnail image.
Throws:
- IndexOutOfBoundsException - if the supplied index is negative or larger than the largest valid index.
- ClassCastException - if a non-BufferedImage object is encountered in the list of thumbnails at the given index.
See Also: IIOImage.getThumbnails(), IIOImage.setThumbnails(java.util.List),

public List<BufferedImage> getThumbnails ()

Returns the current List of thumbnail BufferedImages, or null if none is set.

Returns the current List of thumbnail
BufferedImages, or null if none is
set. A live reference is returned.
Returns: the current List of BufferedImage thumbnails, or null.
See Also: IIOImage.getThumbnail(int), IIOImage.setThumbnails(java.util.List),

public boolean hasRaster ()

Returns true if this IIOImage stores a Raster rather than a RenderedImage.

Returns true if this IIOImage stores
a Raster rather than a RenderedImage.
Returns: true if a Raster is available.

public void setMetadata (IIOMetadata metadata)

Sets the IIOMetadata to a new object, or null.

Sets the IIOMetadata to a new object, or
null.
Parameters:
- metadata - an IIOMetadata object, or null.
See Also: IIOImage.getMetadata(),

public void setRaster (Raster raster)

Sets the current Raster.

Sets the current Raster. The value is
stored by reference. Any existing RenderedImage is
discarded.
Parameters:
- raster - a Raster.
Throws:
- IllegalArgumentException - if raster is null.
See Also: IIOImage.getRaster(),

public void setRenderedImage (RenderedImage image)

Sets the current RenderedImage.

Sets the current RenderedImage. The value is
stored by reference. Any existing Raster is
discarded.
Parameters:
- image - a RenderedImage.
Throws:
- IllegalArgumentException - if image is null.
See Also: IIOImage.getRenderedImage(),

public void setThumbnails (List<BufferedImage> thumbnails)

Sets the list of thumbnails to a new List of BufferedImages, or to null.

Sets the list of thumbnails to a new List of BufferedImages, or to null. The reference to the previous List is discarded.

The thumbnails argument must either be null or contain only BufferedImage objects.
Parameters:
- thumbnails - a List of BufferedImage thumbnails, or null.
See Also: IIOImage.getThumbnail(int), IIOImage.getThumbnails(),