javax.imageio
类 IIOImage

java.lang.Object
  javax.imageio.IIOImage

public class IIOImage
     

      extends 
      Object
     

一个聚集图像、缩略（预览）图像集和表示与图像关联的元数据的对象的简单容器类。

图像数据可以采用 RenderedImage 或 Raster 的形式。返回 IIOImage 的 reader 方法将总是返回一个使用 RenderedImage 引用的 BufferedImage。接受 IIOImage 的 writer 方法将总是接受 RenderedImage，并且可能有选择地接受 Raster。

getRenderedImage 和 getRaster 中只有一个将返回非 null 值。子类负责确保此行为。

另请参见：

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)

image

protected RenderedImage image

正被引用的 RenderedImage。

raster

protected Raster raster

正被引用的 Raster。

thumbnails

protected List<? extends BufferedImage> thumbnails

BufferedImage 缩略图的 List，或为 null。非 BufferedImage 对象一定不能存储在此 List 中。

metadata

protected IIOMetadata metadata

包含与图像关联的元数据的 IIOMetadata 对象。

IIOImage

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

构造一个 IIOImage，它包含 RenderedImage 以及与之关联的缩略图和元数据。

所有参数都是通过引用进行存储的。

thumbnails 参数必须为 null 或者只包含 BufferedImage 对象。

参数：

image - 一个 RenderedImage。

thumbnails - BufferedImage 的 List，或者为 null。

metadata - IIOMetadata 对象，或者为 null。

抛出：

IllegalArgumentException - 如果 image 为 null。

IIOImage

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

构造一个 IIOImage，它包含 Raster 以及与之关联的缩略图和元数据。

所有参数都是通过引用进行存储的。

参数：

raster - 一个 Raster。

thumbnails - BufferedImage 的 List，或者为 null。

metadata - IIOMetadata 对象，或者为 null。

抛出：

IllegalArgumentException - 如果 raster 为 null。

getRenderedImage

public RenderedImage getRenderedImage()

返回当前设置好的 RenderedImage，如果只有一个 Raster 可用，则返回 null。

返回：

RenderedImage 或 null。

另请参见：

setRenderedImage(java.awt.image.RenderedImage)

setRenderedImage

public void setRenderedImage(RenderedImage image)

设置当前 RenderedImage。该值是通过引用进行存储的。任何现有 Raster 都被丢弃。

参数：

image - 一个 RenderedImage。

抛出：

IllegalArgumentException - 如果 image 为 null。

另请参见：

getRenderedImage()

hasRaster

public boolean hasRaster()

如果此 IIOImage 存储了一个 Raster 而不是 RenderedImage，则返回 true。

返回：

如果 Raster 可用，则返回 true。

getRaster

public Raster getRaster()

返回当前设置好的 Raster，如果只有一个 RenderedImage 可用，则返回 null。

返回：

Raster 或 null。

另请参见：

setRaster(java.awt.image.Raster)

setRaster

public void setRaster(Raster raster)

设置当前 Raster。该值是通过引用进行存储的。任何现有 RenderedImage 都被丢弃。

参数：

raster - 一个 Raster。

抛出：

IllegalArgumentException - 如果 raster 为 null。

另请参见：

getRaster()

getNumThumbnails

public int getNumThumbnails()

返回此 IIOImage 中存储的缩略图的数量。

返回：

以 int 值形式返回缩略图的数量。

getThumbnail

public BufferedImage getThumbnail(int index)

返回与主图像关联的缩略图。

参数：

index - 所需缩略图图像的索引。

返回：

以 BufferedImage 形式返回缩略图图像。

抛出：

IndexOutOfBoundsException - 如果所提供的索引为负或大于最大有效索引。

ClassCastException - 如果在缩略图列表中的给定索引处遇到一个非 BufferedImage 对象。

另请参见：

getThumbnails(), setThumbnails(java.util.List )

getThumbnails

public List<? extends BufferedImage> getThumbnails()

返回缩略图 BufferedImage 的当前 List，如果没有设置任何缩略图，则返回 null。返回一个激活的引用。

返回：

BufferedImage 缩略图的当前 List；或者 null。

另请参见：

getThumbnail(int), setThumbnails(java.util.List )

setThumbnails

public void setThumbnails(List<? extends BufferedImage> thumbnails)

将缩略图列表设置为 BufferedImage 的一个新 List 或 null。丢弃对以前 List 的引用。

thumbnails 参数必须为 null 或者只包含 BufferedImage 对象。

参数：

thumbnails - BufferedImage 缩略图的 List，或者为 null。

另请参见：

getThumbnail(int), getThumbnails()

getMetadata

public IIOMetadata getMetadata()

返回对当前 IIOMetadata 对象的引用，如果没有设置任何这样的对象，则返回 null。

返回：

IIOMetadata 对象或者 null。

另请参见：

setMetadata(javax.imageio.metadata.IIOMetadata)

setMetadata

public void setMetadata(IIOMetadata metadata)

将 IIOMetadata 设置为一个新对象或 null。

参数：

metadata - IIOMetadata 对象，或者为 null。

另请参见：

getMetadata()