Класс ImageInputStreamSpi

java.lang.Object

javax.imageio.spi.IIOServiceProvider

javax.imageio.spi.ImageInputStreamSpi

Все реализуемые интерфейсы:: RegisterableService

public abstract class ImageInputStreamSpi extends IIOServiceProvider

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

Этот интерфейс позволяет произвольным объектам быть "обёрнутыми" экземплярами ImageInputStream. Например, определённый ImageInputStreamSpi может позволить использовать универсальный InputStream в качестве источника входных данных; другой может принимать входные данные из URL.

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

См. также:

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

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

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

vendorName, version

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

ImageInputStreamSpi()

ImageInputStreamSpi(String vendorName,
 String version,
 Class<?> inputClass)

Модификатор	Конструктор	Описание
`protected`	Создаёт пустой `ImageInputStreamSpi`. От подкласса зависит инициализация переменных экземпляра и/или переопределение реализации методов для предоставления рабочих версий всех методов.
	Создаёт `ImageInputStreamSpi` с заданным набором значений.

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

Модификатор и тип	Метод	Описание
`boolean`	`canUseCacheFile()`	Возвращает `true`, если реализация `ImageInputStream` , связанная с этим поставщиком сервиса, может выборочно использовать файл кэша для повышения производительности и/или уменьшения потребления памяти.
`ImageInputStream`	`createInputStreamInstance(Object input)`	Возвращает экземпляр реализации `ImageInputStream` , связанной с этим поставщиком сервиса.
`abstract ImageInputStream`	`createInputStreamInstance(Object input, boolean useCache, File cacheDir)`	Возвращает экземпляр реализации `ImageInputStream` , связанной с этим поставщиком сервиса.
`Class<?>`	`getInputClass()`	Возвращает объект `Class` , представляющий тип класса или интерфейса, который должен быть реализован источником входных данных для "обёртки" в `ImageInputStream` с помощью метода `createInputStreamInstance`.
`boolean`	`needsCacheFile()`	Возвращает `true`, если реализация `ImageInputStream` , связанная с этим поставщиком сервиса, требует использования кэша `File`.

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

getDescription, getVendorName, getVersion, onDeregistration, onRegistration

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

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

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

inputClass

protected Class<?> inputClass

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

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

ImageInputStreamSpi

protected ImageInputStreamSpi()

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

ImageInputStreamSpi

public ImageInputStreamSpi(String vendorName, String version, Class<?> inputClass)

Создаёт ImageInputStreamSpi с заданным набором значений.

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

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

getInputClass

public Class<?> getInputClass()

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

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

Возвращает:

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

См. также:

canUseCacheFile

public boolean canUseCacheFile()

Возвращает true , если реализация ImageInputStream , связанная с этим поставщиком сервиса, может выборочно использовать файл кэша для повышения производительности и/или уменьшения потребления памяти. Если false, значение аргумента useCache в createInputStreamInstance будет проигнорировано.

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

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

needsCacheFile

public boolean needsCacheFile()

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

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

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

createInputStreamInstance

public abstract ImageInputStream createInputStreamInstance(Object input, boolean useCache, File cacheDir) throws IOException

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

Параметры:

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

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

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

Возвращает:

экземпляр ImageInputStream.

Исключения:

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

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

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

См. также:

createInputStreamInstance

public ImageInputStream createInputStreamInstance(Object input) throws IOException

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

Параметры:

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

Возвращает:

экземпляр ImageInputStream.

Исключения:

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

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

См. также:

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