Класс 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`.

Методы, объявленные в классе 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

List миниатюр BufferedImage или null. В этом List нельзя хранить объекты, отличные от BufferedImage.

metadata

protected IIOMetadata metadata

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

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

IIOImage

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

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

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

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

Параметры:: image — RenderedImage.; thumbnails — List из BufferedImage или null.; metadata — объект IIOMetadata или null.
Исключения:: IllegalArgumentException — если image равен null.

IIOImage

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

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

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

Параметры:: raster — Raster.; thumbnails — List из BufferedImage или null.; metadata — объект IIOMetadata или null.
Исключения:: IllegalArgumentException — если raster равен null.

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

getRenderedImage

public RenderedImage getRenderedImage()

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

Возвращает:

RenderedImage или null.

См. также:

setRenderedImage

public void setRenderedImage(RenderedImage image)

Задаёт текущий RenderedImage. Значение сохраняется по ссылке. Все существующие Raster удаляются.

Параметры:

image — RenderedImage.

Исключения:

IllegalArgumentException — если image равен null.

См. также:

hasRaster

public boolean hasRaster()

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

Возвращает:: true, если доступен Raster.

getRaster

public Raster getRaster()

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

Возвращает:

Raster или null.

См. также:

setRaster

public void setRaster(Raster raster)

Задаёт текущий Raster. Значение сохраняется по ссылке. Все существующие RenderedImage удаляются.

Параметры:

raster — Raster.

Исключения:

IllegalArgumentException — если raster равен null.

См. также:

getNumThumbnails

public int getNumThumbnails()

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

Возвращает:: количество миниатюр в виде значения int.

getThumbnail

public BufferedImage getThumbnail(int index)

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

Параметры:

index — индекс нужной миниатюры.

Возвращает:

миниатюру в виде BufferedImage.

Исключения:

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

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

См. также:

getThumbnails

public List<? extends BufferedImage> getThumbnails()

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

Возвращает:

текущий List из BufferedImage миниатюр или null.

См. также:

setThumbnails

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

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

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

Параметры:

thumbnails — List из BufferedImage миниатюр или null.

См. также:

getMetadata

public IIOMetadata getMetadata()

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

Возвращает:

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

См. также:

setMetadata

public void setMetadata(IIOMetadata metadata)

Задаёт для IIOMetadata новый объект или null.

Параметры:

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

См. также:

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/javax/imageio/IIOImage.html