javax.imageio

クラスIIOImage

java.lang.Object

javax.imageio.IIOImage

public class IIOImage
extends Object

イメージ、サムネール(プレビュー)イメージ・セット、およびイメージに関連するメタデータを表すオブジェクトを集合させる単純なコンテナ・クラスです。

イメージ・データは、RenderedImage形式かRaster形式のいずれかを取ります。IIOImageを返す読込み用メソッドは、RenderedImage参照を使用して、常にBufferedImageを返します。IIOImageを受け入れる書込み用メソッドは、常にRenderedImageを受け入れますが、オプションによってRasterを受け入れる場合もあります。

getRenderedImageとgetRasterのうちの1つが確実に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)

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
protected RenderedImage	image 参照されたRenderedImageです。
protected IIOMetadata	metadata イメージに関連したメタデータを保持するIIOMetadataオブジェクト。
protected Raster	raster 参照されたRasterです。
protected List<? extends BufferedImage>	thumbnails BufferedImageサムネールのList、またはnull。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
IIOImage(Raster raster, List<? extends BufferedImage> thumbnails, IIOMetadata metadata) Rasterを保持するIIOImageと、それに関連するサムネールとメタデータを構築します。
IIOImage(RenderedImage image, List<? extends BufferedImage> thumbnails, IIOMetadata metadata) RenderedImageを保持するIIOImageと、それに関連するサムネールとメタデータを構築します。

メソッドのサマリー

修飾子と型	メソッドと説明
IIOMetadata	getMetadata() 現在のIIOMetadataオブジェクトへの参照を返します。何も設定されない場合は、nullを返します。
int	getNumThumbnails() このIIOImageに格納されているサムネールの数を返します。
Raster	getRaster() 現在設定されているRasterか、RenderedImageだけを使用できる場合はnullを返します。
RenderedImage	getRenderedImage() 現在設定されているRenderedImageか、Rasterだけを使用できる場合はnullを返します。
BufferedImage	getThumbnail(int index) メイン・イメージに関連するサムネールを返します。
List<? extends BufferedImage>	getThumbnails() サムネールBufferedImageの最新Listを返します。何も設定されていない場合はnullを返します。
boolean	hasRaster() このIIOImageがRenderedImageではなく、Rasterを格納する場合はtrueを返します。
void	setMetadata(IIOMetadata metadata) IIOMetadataを新しいオブジェクトか、nullに設定します。
void	setRaster(Raster raster) 現在のRasterを設定します。
void	setRenderedImage(RenderedImage image) 現在のRenderedImageを設定します。
void	setThumbnails(List<? extends BufferedImage> thumbnails) サムネールのリストを、新しいBufferedImageのListか、nullに設定します。

クラス java.lang.Objectから継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

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)

RenderedImageを保持するIIOImageと、それに関連するサムネールとメタデータを構築します。

すべてのパラメータが参照によって格納されます。

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)

Rasterを保持するIIOImageと、それに関連するサムネールとメタデータを構築します。

すべてのパラメータが参照によって格納されます。

パラメータ:

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がRenderedImageではなく、Rasterを格納する場合は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<? extends java.awt.image.BufferedImage>)

getThumbnails

public List<? extends BufferedImage> getThumbnails()

サムネールBufferedImageの最新Listを返します。何も設定されていない場合はnullを返します。ライブ参照は返されます。

戻り値:

BufferedImageサムネールの現在のListまたはnull。

関連項目:

getThumbnail(int), setThumbnails(java.util.List<? extends java.awt.image.BufferedImage>)

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()