This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

javax.imageio
class IIOImage

java.lang.Object extended by javax.imageio.IIOImage 
public class IIOImage
extends Object

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

The image data may take the form of either a RenderedImage, or a Raster. Reader methods that return an IIOImage will always return a BufferedImage using the RenderedImage reference. Writer methods that accept an IIOImage will always accept a RenderedImage, and may optionally accept a Raster.

Exactly one of getRenderedImage and getRaster will return a non-null value. Subclasses are responsible for ensuring this behavior.

Field Summary
protected RenderedImage image
          The RenderedImage being referenced.
protected IIOMetadata metadata
          An IIOMetadata object containing metadata associated with the image.
protected Raster raster
          The Raster being referenced.
protected List thumbnails
          A List of BufferedImage thumbnails, or null.
 
Constructor Summary
IIOImage(Raster raster, List thumbnails, IIOMetadata metadata)

          Constructs an IIOImage containing a Raster, and thumbnails and metadata associated with it.
IIOImage(RenderedImage image, List thumbnails, IIOMetadata metadata)

          Constructs an IIOImage containing a RenderedImage, and thumbnails and metadata associated with it.
 
Method Summary
 IIOMetadata
getMetadata()

          Returns a reference to the current IIOMetadata object, or null is none is set.
 int
getNumThumbnails()

          Returns the number of thumbnails stored in this IIOImage.
 Raster
getRaster()

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

          Returns the currently set RenderedImage, or null if only a Raster is available.
 BufferedImage
getThumbnail(int index)

          Returns a thumbnail associated with the main image.
 List
getThumbnails()

          Returns the current List of thumbnail BufferedImages, or null if none is set.
 boolean
hasRaster()

          Returns true if this IIOImage stores a Raster rather than a RenderedImage.
 void
setMetadata(IIOMetadata metadata)

          Sets the IIOMetadata to a new object, or null.
 void
setRaster(Raster raster)

          Sets the current Raster.
 void
setRenderedImage(RenderedImage image)

          Sets the current RenderedImage.
 void
setThumbnails(List thumbnails)

          Sets the list of thumbnails to a new List of BufferedImages, or to null.
 
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.

metadata

protected IIOMetadata metadata
An IIOMetadata object containing metadata associated with the image.

raster

protected Raster raster
The Raster being referenced.

thumbnails

protected List thumbnails
A List of BufferedImage thumbnails, or null. Non-BufferedImage objects must not be stored in this List.
Constructor Detail

IIOImage

public IIOImage(Raster raster,
                List 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.

IIOImage

public IIOImage(RenderedImage image,
                List 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.
Method Detail

getMetadata

public IIOMetadata getMetadata()
Returns a reference to the current IIOMetadata object, or null is none is set.

Returns:
an IIOMetadata object, or null.

getNumThumbnails

public int getNumThumbnails()
Returns the number of thumbnails stored in this IIOImage.

Returns:
the number of thumbnails, as an int.

getRaster

public Raster getRaster()
Returns the currently set Raster, or null if only a RenderedImage is available.

Returns:
a Raster, or null.

getRenderedImage

public RenderedImage getRenderedImage()
Returns the currently set RenderedImage, or null if only a Raster is available.

Returns:
a RenderedImage, or null.

getThumbnail

public BufferedImage getThumbnail(int index)
Returns a thumbnail associated with the main image.

Parameters:
index - the index of the desired thumbnail image.
Returns:
a thumbnail image, as a BufferedImage.

getThumbnails

public List getThumbnails()
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.

hasRaster

public boolean hasRaster()
Returns true if this IIOImage stores a Raster rather than a RenderedImage.

Returns:
true if a Raster is available.

setMetadata

public void setMetadata(IIOMetadata metadata)
Sets the IIOMetadata to a new object, or null.

Parameters:
metadata - an IIOMetadata object, or null.

setRaster

public void setRaster(Raster raster)
Sets the current Raster. The value is stored by reference. Any existing RenderedImage is discarded.

Parameters:
raster - a Raster.

setRenderedImage

public void setRenderedImage(RenderedImage image)
Sets the current RenderedImage. The value is stored by reference. Any existing Raster is discarded.

Parameters:
image - a RenderedImage.

setThumbnails

public void setThumbnails(List thumbnails)
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.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.