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

См. также:

createInputStreamInstance(Object, boolean, File)

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

Возвращает:

экземпляр ImageInputStream.

Исключения:

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

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

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

См. также:

getInputClass()
canUseCacheFile()
needsCacheFile()

createInputStreamInstance

public ImageInputStream createInputStreamInstance(Object input) throws IOException

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

Параметры:

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

Возвращает:

экземпляр ImageInputStream.

Исключения:

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

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

См. также:

getInputClass()

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