Класс ImageOutputStreamSpi

java.lang.Object

javax.imageio.spi.IIOServiceProvider

javax.imageio.spi.ImageOutputStreamSpi

Все реализованные интерфейсы:: RegisterableService

public abstract class ImageOutputStreamSpi extends IIOServiceProvider

Интерфейс поставщика услуг (SPI) для ImageOutputStream. Дополнительную информацию об интерфейсах поставщиков услуг см. в комментарии к классу IIORegistry.

Этот интерфейс позволяет произвольным объектам быть «обораченными» экземплярами ImageOutputStream. Например, определённый ImageOutputStreamSpi может позволить использовать общий OutputStream в качестве пункта назначения; другой — выводить в File или на устройство, такое как последовательный порт.

Представляя создание ImageOutputStream как подключаемый сервис, становится возможным обрабатывать будущие пункты назначения вывода без изменения API. Также, высокопроизводительные реализации ImageOutputStream (например, родные реализации для определённой платформы) могут быть установлены и использованы приложениями прозрачно.

См. также:

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

Модификатор и тип	Поле	Описание
`protected Class<?>`	`outputClass`	Объект `Class`, указывающий допустимый тип объекта для использования методом `createInputStreamInstance`.

Поля, объявленные в классе javax.imageio.spi.IIOServiceProvider

vendorName, version

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

ImageOutputStreamSpi()

ImageOutputStreamSpi(String vendorName,
 String version,
 Class<?> outputClass)

Модификатор	Конструктор	Описание
`protected`	Создаёт пустой `ImageOutputStreamSpi`.
	Создаёт `ImageOutputStreamSpi` с заданным набором значений.

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

Модификатор и тип	Метод	Описание
`boolean`	`canUseCacheFile()`	Возвращает `true`, если реализация `ImageOutputStream`, связанная с этим поставщиком услуг, может по желанию использовать кэш `File` для повышения производительности и/или уменьшения потребления памяти.
`ImageOutputStream`	`createOutputStreamInstance(Object output)`	Возвращает экземпляр реализации `ImageOutputStream`, связанной с этим поставщиком услуг.
`abstract ImageOutputStream`	`createOutputStreamInstance(Object output, boolean useCache, File cacheDir)`	Возвращает экземпляр реализации `ImageOutputStream`, связанной с этим поставщиком услуг.
`Class<?>`	`getOutputClass()`	Возвращает объект `Class`, представляющий тип класса или интерфейса, который должен быть реализован пунктом назначения вывода, чтобы быть «обораченным» в `ImageOutputStream` посредством метода `createOutputStreamInstance`.
`boolean`	`needsCacheFile()`	Возвращает `true`, если реализация `ImageOutputStream`, связанная с этим поставщиком услуг, требует использования кэша `File`.

Методы, объявленные в классе javax.imageio.spi.IIOServiceProvider

getDescription, getVendorName, getVersion, onDeregistration, onRegistration

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание полей

outputClass

protected Class<?> outputClass

Объект Class, указывающий допустимый тип объекта для использования методом createInputStreamInstance.

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

ImageOutputStreamSpi

protected ImageOutputStreamSpi()

Создаёт пустой ImageOutputStreamSpi. Подклассу необходимо инициализировать переменные экземпляра и/или переопределять реализации методов, чтобы предоставить рабочие версии всех методов.

ImageOutputStreamSpi

public ImageOutputStreamSpi(String vendorName, String version, Class<?> outputClass)

Создаёт ImageOutputStreamSpi с заданными значениями.

Параметры:: vendorName — имя поставщика.; version — идентификатор версии.; outputClass — объект Class, указывающий допустимый тип объекта для использования методом createOutputStreamInstance.
Исключения:: IllegalArgumentException — если vendorName имеет значение null.; IllegalArgumentException — если version имеет значение null.

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

getOutputClass

public Class<?> getOutputClass()

Возвращает объект Class, представляющий тип класса или интерфейса, который должен быть реализован целевым выходом для "оборачивания" в ImageOutputStream с помощью метода createOutputStreamInstance.

Типичные возвращаемые значения могут включать в себя OutputStream.class или File.class, но может быть использован любой класс.

Возвращаемое значение:

переменная типа Class.

См. также:

canUseCacheFile

public boolean canUseCacheFile()

Возвращает true, если реализация ImageOutputStream, связанная с этим поставщиком услуг, может необязательно использовать кэш File для повышения производительности и/или снижения потребления памяти. Если false, значение аргумента cacheFile для createOutputStreamInstance будет проигнорировано.

Реализация по умолчанию возвращает false.

Возвращаемое значение:: true, если кэш-файл может быть использован выходными потоками, созданными этим поставщиком услуг.

needsCacheFile

public boolean needsCacheFile()

Возвращает true, если реализация ImageOutputStream, связанная с этим поставщиком услуг, требует использования кэш-файла File.

Реализация по умолчанию возвращает false.

Возвращаемое значение:: true, если кэш-файл необходим выходным потокам, созданными этим поставщиком услуг.

createOutputStreamInstance

public abstract ImageOutputStream createOutputStreamInstance(Object output, boolean useCache, File cacheDir) throws IOException

Возвращает экземпляр реализации ImageOutputStream, связанной с этим поставщиком услуг. Если использование кэш-файла необязательно, будет проконсультирован параметр useCache. В случае необходимости или неприменимости кэша, значение useCache будет проигнорировано.

Параметры:

output — объект типа класса, возвращённого методом getOutputClass.

useCache — значение, указывающее, следует ли использовать кэш-файл в случаях, когда это необязательно.

cacheDir — значение, указывающее, где должен быть создан кэш-файл, или null для использования системного каталога.

Возвращаемое значение:

экземпляр ImageOutputStream.

Исключения:

IllegalArgumentException — если output не является экземпляром правильного класса или является null.

IllegalArgumentException — если кэш-файл необходим, но cacheDir не является путём к каталогу.

IOException — если кэш-файл не может быть создан.

См. также:

createOutputStreamInstance

public ImageOutputStream createOutputStreamInstance(Object output) throws IOException

Возвращает экземпляр реализации ImageOutputStream, связанной с этим поставщиком услуг. Кэш-файл будет создан в зависимости от системы в стандартном временном каталоге, если это необходимо.

Параметры:

output — объект типа класса, возвращённого методом getOutputClass.

Возвращаемое значение:

экземпляр ImageOutputStream.

Исключения:

IllegalArgumentException — если output не является экземпляром правильного класса или является null.

IOException — если кэш-файл необходим, но не может быть создан.

См. также:

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/imageio/spi/ImageOutputStreamSpi.html