public class IIOImage extends Object
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.
Modifier and Type | Field | Description |
---|---|---|
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 | Description |
---|---|
IIOImage |
Constructs an IIOImage containing a Raster , and thumbnails and metadata associated with it. |
IIOImage |
Constructs an IIOImage containing a RenderedImage , and thumbnails and metadata associated with it. |
Modifier and Type | Method | Description |
---|---|---|
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 |
Returns a thumbnail associated with the main image. |
List |
getThumbnails() |
Returns the current List of thumbnail BufferedImage s, or null if none is set. |
boolean |
hasRaster() |
Returns true if this IIOImage stores a Raster rather than a RenderedImage . |
void |
setMetadata |
Sets the IIOMetadata to a new object, or null . |
void |
setRaster |
Sets the current Raster . |
void |
setRenderedImage |
Sets the current RenderedImage . |
void |
setThumbnails |
Sets the list of thumbnails to a new List of BufferedImage s, or to null . |
protected RenderedImage image
RenderedImage
being referenced.protected Raster raster
Raster
being referenced.protected List<? extends BufferedImage> thumbnails
List
of BufferedImage
thumbnails, or null
. Non-BufferedImage
objects must not be stored in this List
.protected IIOMetadata metadata
IIOMetadata
object containing metadata associated with the image.public IIOImage(RenderedImage image, List<? extends BufferedImage> thumbnails, IIOMetadata metadata)
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.
image
- a RenderedImage
.thumbnails
- a List
of BufferedImage
s, or null
.metadata
- an IIOMetadata
object, or null
.IllegalArgumentException
- if image
is null
.public IIOImage(Raster raster, List<? extends BufferedImage> thumbnails, IIOMetadata metadata)
IIOImage
containing a Raster
, and thumbnails and metadata associated with it. All parameters are stored by reference.
raster
- a Raster
.thumbnails
- a List
of BufferedImage
s, or null
.metadata
- an IIOMetadata
object, or null
.IllegalArgumentException
- if raster
is null
.public RenderedImage getRenderedImage()
RenderedImage
, or null
if only a Raster
is available.RenderedImage
, or null
.public void setRenderedImage(RenderedImage image)
RenderedImage
. The value is stored by reference. Any existing Raster
is discarded.image
- a RenderedImage
.IllegalArgumentException
- if image
is null
.public boolean hasRaster()
true
if this IIOImage
stores a Raster
rather than a RenderedImage
.true
if a Raster
is available.public Raster getRaster()
Raster
, or null
if only a RenderedImage
is available.Raster
, or null
.public void setRaster(Raster raster)
Raster
. The value is stored by reference. Any existing RenderedImage
is discarded.raster
- a Raster
.IllegalArgumentException
- if raster
is null
.public int getNumThumbnails()
IIOImage
.int
.public BufferedImage getThumbnail(int index)
index
- the index of the desired thumbnail image.BufferedImage
.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.public List<? extends BufferedImage> getThumbnails()
List
of thumbnail BufferedImage
s, or null
if none is set. A live reference is returned.List
of BufferedImage
thumbnails, or null
.public void setThumbnails(List<? extends BufferedImage> thumbnails)
List
of BufferedImage
s, or to null
. The reference to the previous List
is discarded. The thumbnails
argument must either be null
or contain only BufferedImage
objects.
thumbnails
- a List
of BufferedImage
thumbnails, or null
.public IIOMetadata getMetadata()
IIOMetadata
object, or null
is none is set.IIOMetadata
object, or null
.public void setMetadata(IIOMetadata metadata)
IIOMetadata
to a new object, or null
.metadata
- an IIOMetadata
object, or null
.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/imageio/IIOImage.html