Класс IIOImage

java.lang.Object
- javax.imageio.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

Список 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(java.awt.image.RenderedImage)

setRenderedImage

public void setRenderedImage(RenderedImage image)

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

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

hasRaster

public boolean hasRaster()

Возвращает true, если этот IIOImage хранит 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()

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

Возвращает:: количество миниатюр как 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, если не задан. Возвращается живая ссылка.

Возвращает:: текущий список BufferedImage миниатюр или 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()

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

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

setMetadata

public void setMetadata(IIOMetadata metadata)

Устанавливает IIOMetadata на новый объект или 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.