Класс ImageInputStreamSpi

java.lang.Object

javax.imageio.spi.IIOServiceProvider

javax.imageio.spi.ImageInputStreamSpi

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

public abstract class ImageInputStreamSpi extends IIOServiceProvider

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

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

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

См. также:

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

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

Поля, объявленные в классе 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`.

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

getDescription, getVendorName, getVersion, onDeregistration, onRegistration

Методы, объявленные в классе 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 — значение boolean, указывающее, следует ли использовать файл кэша, если его использование необязательно.

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

Возвращает:

экземпляр ImageInputStream.

Исключения:

IllegalArgumentException — если input не является экземпляром требуемого класса или имеет значение null.

IllegalArgumentException — если требуется файл кэша, но cacheDir не имеет значения null и не является каталогом.

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://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/javax/imageio/spi/ImageInputStreamSpi.html