Home » openjdk-7 » javax » imageio » [javadoc | source]
javax.imageio
public class: IIOImage [javadoc | source]
java.lang.Object
   javax.imageio.IIOImage
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  Raster raster    The Raster being referenced. 
protected  List<BufferedImage> thumbnails    A List of BufferedImage thumbnails, or null. Non-BufferedImage objects must not be stored in this List
protected  IIOMetadata metadata    An IIOMetadata object containing metadata associated with the image. 
Constructor:
 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.
    exception: IllegalArgumentException - if image is null.
 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.
    exception: IllegalArgumentException - if raster is null.
Method from javax.imageio.IIOImage Summary:
getMetadata,   getNumThumbnails,   getRaster,   getRenderedImage,   getThumbnail,   getThumbnails,   hasRaster,   setMetadata,   setRaster,   setRenderedImage,   setThumbnails
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.imageio.IIOImage Detail:
 public IIOMetadata getMetadata() 
    Returns a reference to the current IIOMetadata object, or null is none is set.
 public int getNumThumbnails() 
    Returns the number of thumbnails stored in this IIOImage.
 public Raster getRaster() 
    Returns the currently set Raster, or null if only a RenderedImage is available.
 public RenderedImage getRenderedImage() 
    Returns the currently set RenderedImage, or null if only a Raster is available.
 public BufferedImage getThumbnail(int index) 
    Returns a thumbnail associated with the main image.
 public List<BufferedImage> getThumbnails() 
    Returns the current List of thumbnail BufferedImages, or null if none is set. A live reference is returned.
 public boolean hasRaster() 
    Returns true if this IIOImage stores a Raster rather than a RenderedImage.
 public  void setMetadata(IIOMetadata metadata) 
    Sets the IIOMetadata to a new object, or null.
 public  void setRaster(Raster raster) 
    Sets the current Raster. The value is stored by reference. Any existing RenderedImage is discarded.
 public  void setRenderedImage(RenderedImage image) 
    Sets the current RenderedImage. The value is stored by reference. Any existing Raster is discarded.
 public  void setThumbnails(List<BufferedImage> 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.