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 オブジェクトへの参照を返します。
int	getNumThumbnails() この IIOImage に格納されているサムネールの数を返します。
Raster	getRaster() 現在設定されている Raster か、RenderedImage だけを使用できる場合は null を返します。
RenderedImage	getRenderedImage() 現在設定されている RenderedImage か、Raster だけを使用できる場合は null を返します。
BufferedImage	getThumbnail(int index) メインイメージに関連するサムネールを返します。
List<? extends BufferedImage>	getThumbnails() サムネール BufferedImage の現在の List を返します。
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)

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