Класс 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.

См. также:

createOutputStreamInstance(Object, boolean, File)

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 - File указывающий, где должен быть создан кэш-файл, или null для использования системного каталога.

Возвращает:

экземпляр ImageOutputStream.

Исключения:

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

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

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

См. также:

getOutputClass()

createOutputStreamInstance

public ImageOutputStream createOutputStreamInstance(Object output) throws IOException

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

Параметры:

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

Возвращает:

экземпляр ImageOutputStream.

Исключения:

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

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

См. также:

getOutputClass()

© 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/spi/ImageOutputStreamSpi.html