Класс IIOImage

java.lang.Object

javax.imageio.IIOImage

public class IIOImage extends Object

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

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

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

See Also:

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

Модификатор и тип	Поле	Описание
`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

Список 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 - список BufferedImage миниатюр, или null.; metadata - объект IIOMetadata, или null.
Исключения:: IllegalArgumentException - если image равен null.

IIOImage

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

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

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

Параметры:: raster - объект Raster.; thumbnails - список 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 миниатюр, или null если он не задан. Возвращается живая ссылка.

Возвращает:

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

См. также:

setThumbnails

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

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

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

Параметры:

thumbnails - список BufferedImage миниатюр, или null.

См. также:

getMetadata

public IIOMetadata getMetadata()

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

Возвращает:

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

См. также:

setMetadata

public void setMetadata(IIOMetadata metadata)

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

Параметры:

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

См. также:

© 1993, 2023, 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/21/docs/api/java.desktop/javax/imageio/IIOImage.html