Spec-Zone.ru › OpenJDK 21

Интерфейс IIOWriteProgressListener

Все суперинтерфейсы:
EventListener
public interface IIOWriteProgressListener extends EventListener
Интерфейс, используемый реализациями ImageWriter для уведомления вызывающих сторон о ходе их методов записи изображений.
См. также:
  • ImageWriter.write(javax.imageio.metadata.IIOMetadata, javax.imageio.IIOImage, javax.imageio.ImageWriteParam)

Краткое описание методов

Модификатор и тип Метод Описание
void imageComplete(ImageWriter source)
Сообщает, что операция записи изображения завершена.
void imageProgress(ImageWriter source, float percentageDone)
Сообщает приблизительную степень выполнения текущего вызова write в рамках связанного ImageWriter.
void imageStarted(ImageWriter source, int imageIndex)
Сообщает, что операция записи изображения началась.
void thumbnailComplete(ImageWriter source)
Сообщает, что операция записи миниатюры завершена.
void thumbnailProgress(ImageWriter source, float percentageDone)
Сообщает приблизительную степень выполнения текущей записи миниатюры в связанном ImageWriter.
void thumbnailStarted(ImageWriter source, int imageIndex, int thumbnailIndex)
Сообщает, что операция записи миниатюры началась.
void writeAborted(ImageWriter source)
Сообщает, что запись была прервана с помощью метода abort записывателя.

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

imageStarted

void imageStarted(ImageWriter source, int imageIndex)
Сообщает, что операция записи изображения началась. Все реализации ImageWriter обязаны вызвать этот метод ровно один раз при начале операции записи изображения.
Параметры:
source - объект ImageWriter, вызвавший этот метод.
imageIndex - индекс изображения, записываемого в содержащий его входной файл или поток.

imageProgress

void imageProgress(ImageWriter source, float percentageDone)
Сообщает приблизительную степень выполнения текущего вызова write в рамках связанного ImageWriter.

Степень выполнения выражается как индекс, указывающий на записываемое изображение, и процент, варьирующийся от 0.0F до 100.0F и указывающий, сколько текущего изображения было выведено. Процент должен, по идее, рассчитываться в зависимости от оставшегося времени до завершения, но обычно практичнее использовать более определённый метрический показатель, например, количество декодированных пикселей или часть потреблённого входного потока. В любом случае, последовательность вызовов этого метода во время данной операции чтения должна предоставлять монотонно возрастающую последовательность значений процента. Нет необходимости передавать точные значения 0 и 100, так как они могут быть выведены вызывающим методом из других методов.

Каждая конкретная реализация ImageWriter может вызывать этот метод с любой желаемой частотой. Правило хорошего тона — вызывать его примерно каждые 5 процентов.

Параметры:
source - объект ImageWriter, вызвавший этот метод.
percentageDone - приблизительный процент завершенного декодирования.

imageComplete

void imageComplete(ImageWriter source)
Сообщает, что операция записи изображения завершена. Все реализации ImageWriter обязаны вызвать этот метод ровно один раз по завершении каждой операции записи изображения.
Параметры:
source - объект ImageWriter, вызвавший этот метод.

thumbnailStarted

void thumbnailStarted(ImageWriter source, int imageIndex, int thumbnailIndex)
Сообщает, что операция записи миниатюры началась. Все реализации ImageWriter обязаны вызвать этот метод ровно один раз при начале операции записи миниатюры.
Параметры:
source - объект ImageWrite, вызвавший этот метод.
imageIndex - индекс изображения, записываемого в содержащий его входной файл или поток.
thumbnailIndex - индекс записываемой миниатюры.

thumbnailProgress

void thumbnailProgress(ImageWriter source, float percentageDone)
Сообщает приблизительную степень выполнения текущей записи миниатюры в связанном ImageWriter. Семантика идентична семантике imageProgress.
Параметры:
source - объект ImageWriter, вызвавший этот метод.
percentageDone - приблизительный процент завершенного декодирования.

thumbnailComplete

void thumbnailComplete(ImageWriter source)
Сообщает, что операция записи миниатюры завершена. Все реализации ImageWriter обязаны вызвать этот метод ровно один раз по завершении каждой операции записи миниатюры.
Параметры:
source - объект ImageWriter, вызвавший этот метод.

writeAborted

void writeAborted(ImageWriter source)
Сообщает, что запись была прервана с помощью метода abort записывателя. Больше уведомлений не будет.
Параметры:
source - объект ImageWriter, вызвавший этот метод.

© 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/event/IIOWriteProgressListener.html

Spec-Zone.ru

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