Класс 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, 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/ImageInputStreamSpi.html