Класс IIOImage

java.lang.Object

javax.imageio.IIOImage

public class IIOImage extends Object

Простой контейнерный класс для агрегирования изображения, набора миниатюр (превью) изображений и объекта, представляющего метаданные, связанные с изображением.

Данные изображения могут быть представлены в формате RenderedImage или в формате Raster. Методы чтения, возвращающие IIOImage, всегда возвращают BufferedImage, используя ссылку RenderedImage. Методы записи, принимающие IIOImage, всегда принимают RenderedImage и могут необязательно принять Raster.

Ровно один из getRenderedImage и getRaster вернёт значение, отличное от null. Подклассы несут ответственность за обеспечение этого поведения.

См. также:

Краткое описание полей

Модификатор и тип	Поле	Описание
`protected RenderedImage`	`image`	Ссылка на используемое `RenderedImage`.
`protected IIOMetadata`	`metadata`	Объект `IIOMetadata`, содержащий метаданные, связанные с изображением.
`protected Raster`	`raster`	Ссылка на используемое `Raster`.
`protected List<? extends BufferedImage>`	`thumbnails`	Список `List` `BufferedImage` миниатюр или `null`.

Краткое описание конструкторов

Конструктор	Описание
`IIOImage(Raster raster, List<? extends BufferedImage> thumbnails, IIOMetadata metadata)`	Создаёт `IIOImage`, содержащий `Raster`, миниатюры и метаданные, связанные с ним.
`IIOImage(RenderedImage image, List<? extends BufferedImage> thumbnails, IIOMetadata metadata)`	Создаёт `IIOImage`, содержащий `RenderedImage`, миниатюры и метаданные, связанные с ним.

Краткое описание методов

Модификатор и тип	Метод	Описание
`IIOMetadata`	`getMetadata()`	Возвращает ссылку на текущий объект `IIOMetadata` или `null`, если он не установлен.
`int`	`getNumThumbnails()`	Возвращает количество миниатюр, хранящихся в этом `IIOImage`.
`Raster`	`getRaster()`	Возвращает текущий `Raster` или `null`, если доступен только `RenderedImage`.
`RenderedImage`	`getRenderedImage()`	Возвращает текущий `RenderedImage` или `null`, если доступен только `Raster`.
`BufferedImage`	`getThumbnail(int index)`	Возвращает миниатюру, связанную с основным изображением.
`List<? extends BufferedImage>`	`getThumbnails()`	Возвращает текущий `List` списка миниатюр `BufferedImage` или `null`, если он не установлен.
`boolean`	`hasRaster()`	Возвращает `true`, если этот `IIOImage` хранит `Raster`, а не `RenderedImage`.
`void`	`setMetadata(IIOMetadata metadata)`	Устанавливает `IIOMetadata` в новый объект или `null`.
`void`	`setRaster(Raster raster)`	Устанавливает текущий `Raster`.
`void`	`setRenderedImage(RenderedImage image)`	Устанавливает текущий `RenderedImage`.
`void`	`setThumbnails(List<? extends BufferedImage> thumbnails)`	Устанавливает список миниатюр в новый `List` `BufferedImage` или в `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

Список миниатюр изображений или null. В этом списке не должны храниться объекты, которые не являются BufferedImage.

metadata

protected IIOMetadata metadata

Объект IIOMetadata, содержащий метаданные изображения.

Подробное описание конструкторов

IIOImage

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

Создает объект IIOImage, содержащий RenderedImage, миниатюры и метаданные, связанные с ним.

Все параметры хранятся по ссылке.

Аргумент thumbnails должен быть либо null, либо содержать только объекты BufferedImage.

Parameters:: image - RenderedImage.; thumbnails - список BufferedImage или null.; metadata - объект IIOMetadata или null.
Throws:: IllegalArgumentException - если image является null.

IIOImage

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

Создаёт объект IIOImage, содержащий Raster, миниатюры и метаданные, связанные с ним.

Все параметры хранятся по ссылке.

Parameters:: raster - Raster.; thumbnails - список BufferedImage или null.; metadata - объект IIOMetadata или null.
Throws:: IllegalArgumentException - если raster является null.

Подробное описание методов

getRenderedImage

public RenderedImage getRenderedImage()

Возвращает текущее установленное значение RenderedImage или null, если доступен только Raster.

Returns:

RenderedImage или null.

See Also:

setRenderedImage

public void setRenderedImage(RenderedImage image)

Устанавливает текущее значение RenderedImage. Значение хранится по ссылке. Любое существующее значение Raster будет удалено.

Parameters:

image - RenderedImage.

Throws:

IllegalArgumentException - если image является null.

See Also:

hasRaster

public boolean hasRaster()

Возвращает true, если этот объект IIOImage хранит Raster, а не RenderedImage.

Returns:: true, если Raster доступен.

getRaster

public Raster getRaster()

Возвращает текущее установленное значение Raster или null, если доступен только RenderedImage.

Returns:

Raster или null.

See Also:

setRaster

public void setRaster(Raster raster)

Устанавливает текущее значение Raster. Значение хранится по ссылке. Любое существующее значение RenderedImage будет удалено.

Parameters:

raster - Raster.

Throws:

IllegalArgumentException - если raster является null.

See Also:

getNumThumbnails

public int getNumThumbnails()

Возвращает количество миниатюр, сохранённых в этом объекте IIOImage.

Returns:: количество миниатюр, как int.

getThumbnail

public BufferedImage getThumbnail(int index)

Возвращает миниатюру, связанную с основным изображением.

Parameters:

index - индекс миниатюры, которую необходимо получить.

Returns:

миниатюра, как BufferedImage.

Throws:

IndexOutOfBoundsException - если переданный индекс отрицательный или превышает максимальный допустимый индекс.

ClassCastException - если в списке миниатюр по указанному индексу обнаружен объект, не являющийся BufferedImage.

See Also:

getThumbnails

public List<? extends BufferedImage> getThumbnails()

Возвращает текущий список миниатюр изображений или null, если он не задан. Возвращается ссылка на список.

Returns:

текущий список миниатюр BufferedImage или null.

See Also:

setThumbnails

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

Устанавливает список миниатюр на новый список BufferedImage или null. Ссылка на предыдущий список List удаляется.

Аргумент thumbnails должен быть либо null, либо содержать только объекты BufferedImage.

Parameters:

thumbnails - список BufferedImage или null.

See Also:

getMetadata

public IIOMetadata getMetadata()

Возвращает ссылку на текущий объект IIOMetadata или null, если он не задан.

Returns:

объект IIOMetadata или null.

See Also:

setMetadata

public void setMetadata(IIOMetadata metadata)

Устанавливает IIOMetadata на новый объект или null.

Parameters:

metadata - объект IIOMetadata или null.

See Also:

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/imageio/IIOImage.html