Класс IIOImage

public class IIOImage
extends Object

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

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

Ровно один из getRenderedImage и getRaster вернёт значение, отличное от 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

Список 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

Список миниатюр BufferedImage, или null. В этом списке не должны храниться объекты, отличные от 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(java.awt.image.RenderedImage)

setRenderedImage

public void setRenderedImage(RenderedImage image)

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

Параметры:
image - объект RenderedImage.
Исключения:
IllegalArgumentException - если image является null.
См. также:
getRenderedImage()

hasRaster

public boolean hasRaster()

Возвращает true если этот объект содержит Raster вместо RenderedImage.

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

getRaster

public Raster getRaster()

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

Возвращает:
объект 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()

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

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

getThumbnail

public BufferedImage getThumbnail(int index)

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

Параметры:
index - индекс нужной миниатюры.
Возвращает:
миниатюра, как объект BufferedImage.
Исключения:
IndexOutOfBoundsException - если переданный индекс отрицательный или превышает максимальный допустимый индекс.
ClassCastException - если в списке миниатюр по заданному индексу встречен объект, отличный от BufferedImage.
См. также:
getThumbnails(), setThumbnails(java.util.List<? extends java.awt.image.BufferedImage>)

getThumbnails

public List<? extends BufferedImage> getThumbnails()

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

Возвращает:
текущий список миниатюр, или null.
См. также:
getThumbnail(int), setThumbnails(java.util.List<? extends java.awt.image.BufferedImage>)

setThumbnails

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

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

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

Параметры:
thumbnails - список миниатюр BufferedImage или null.
См. также:
getThumbnail(int), getThumbnails()

getMetadata

public IIOMetadata getMetadata()

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

Возвращает:
объект IIOMetadata, или null.
См. также:
setMetadata(javax.imageio.metadata.IIOMetadata)

setMetadata

public void setMetadata(IIOMetadata metadata)

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

Параметры:
metadata - объект IIOMetadata, или null.
См. также:
getMetadata()

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

Spec-Zone .ru
спецификации, руководства, описания, API