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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли какой-либо другой объект этому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API может быть удален в будущей версии. Финализация объявлена устаревшей и будет удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения определенного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения определенного промежутка реального времени.

Подробное описание полей

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.