Spec-Zone.ru › OpenJDK 17

Класс 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. Не-BufferedImage объекты не должны храниться в этом List.

metadata

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

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

IIOImage

public IIOImage(RenderedImage image, List<? extends BufferedImage> thumbnails, IIOMetadata metadata)
Создаёт IIOImage содержащий RenderedImage, миниатюры и метаданные, связанные с ним.

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

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

Parameters:
image - RenderedImage.
thumbnails - Список BufferedImage или null.
metadata - IIOMetadata объект или null.
Throws:
IllegalArgumentException - если image является null.

IIOImage

public IIOImage(Raster raster, List<? extends BufferedImage> thumbnails, IIOMetadata metadata)
Создаёт IIOImage содержащий Raster, миниатюры и метаданные, связанные с ним.

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

Parameters:
raster - Raster.
thumbnails - Список BufferedImage или null.
metadata - IIOMetadata объект или null.
Throws:
IllegalArgumentException - если raster является null.

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

getRenderedImage

public RenderedImage getRenderedImage()
Возвращает текущий RenderedImage, или null если доступен только Raster.
Returns:
RenderedImage, или null.
See Also:
  • setRenderedImage(java.awt.image.RenderedImage)

setRenderedImage

public void setRenderedImage(RenderedImage image)
Устанавливает текущий RenderedImage. Значение хранится по ссылке. Любой существующий Raster отбрасывается.
Parameters:
image - RenderedImage.
Throws:
IllegalArgumentException - если image является null.
See Also:
  • getRenderedImage()

hasRaster

public boolean hasRaster()
Возвращает true если этот IIOImage хранит Raster вместо RenderedImage.
Returns:
true если Raster доступен.

getRaster

public Raster getRaster()
Возвращает текущий Raster, или null если доступен только RenderedImage.
Returns:
Raster, или null.
See Also:
  • setRaster(java.awt.image.Raster)

setRaster

public void setRaster(Raster raster)
Устанавливает текущий Raster. Значение хранится по ссылке. Любой существующий RenderedImage отбрасывается.
Parameters:
raster - Raster.
Throws:
IllegalArgumentException - если raster является null.
See Also:
  • getRaster()

getNumThumbnails

public int getNumThumbnails()
Возвращает количество миниатюр, хранящихся в этом IIOImage.
Returns:
Количество миниатюр, как int.

getThumbnail

public BufferedImage getThumbnail(int index)
Возвращает миниатюру, связанную с основным изображением.
Parameters:
index - Индекс нужной миниатюры.
Returns:
Миниатюра, как BufferedImage.
Throws:
IndexOutOfBoundsException - если предоставленный индекс отрицательный или больше максимального допустимого индекса.
ClassCastException - если в списке миниатюр на данном индексе встречен не-BufferedImage объект.
See Also:
  • getThumbnails()
  • setThumbnails(java.util.List<? extends java.awt.image.BufferedImage>)

getThumbnails

public List<? extends BufferedImage> getThumbnails()
Возвращает текущий список миниатюр, или null если ничего не установлено. Возвращается ссылка на объект.
Returns:
Текущий список BufferedImage миниатюр, или null.
See Also:
  • getThumbnail(int)
  • setThumbnails(java.util.List<? extends java.awt.image.BufferedImage>)

setThumbnails

public void setThumbnails(List<? extends BufferedImage> thumbnails)
Устанавливает список миниатюр на новый список List BufferedImage или на null. Ссылка на предыдущий список отбрасывается.

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

Parameters:
thumbnails - список BufferedImage миниатюр, или null.
See Also:
  • getThumbnail(int)
  • getThumbnails()

getMetadata

public IIOMetadata getMetadata()
Возвращает ссылку на текущий IIOMetadata объект, или null если не установлен.
Returns:
объект IIOMetadata, или null.
See Also:
  • setMetadata(javax.imageio.metadata.IIOMetadata)

setMetadata

public void setMetadata(IIOMetadata metadata)
Устанавливает IIOMetadata на новый объект или null.
Parameters:
metadata - IIOMetadata объект или null.
See Also:
  • getMetadata()

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API