Класс ImageReaderSpi

public abstract class ImageReaderSpi
extends ImageReaderWriterSpi

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

Каждый ImageReaderSpi предоставляет несколько типов информации о классе ImageReader, с которым он связан.

Название производителя, определившего класс SPI, и краткое описание класса доступны через методы getVendorName, getDescription, и getVersion. Эти методы могут быть локализованы для предоставления вывода в зависимости от региона. Эти методы предназначены в основном для предоставления краткой, легко читаемой информации, которая может использоваться для организации всплывающего меню или другого списка.

Список имен форматов, расширений файлов и MIME-типов, связанных с сервисом, можно получить с помощью методов getFormatNames, getFileSuffixes, и getMIMETypes. Эти методы могут использоваться для идентификации потенциальных ImageReader для декодирования конкретного файла или потока данных на основе ручного выбора формата, именования файлов или ассоциаций MIME (например, при доступе к файлу через HTTP или как вложение в электронном письме).

Более надёжный способ определить, какие ImageReader могут обработать конкретный поток данных, предоставляется методом canDecodeInput. Этот метод позволяет поставщику сервиса проверить содержимое потока.

Наконец, экземпляр класса ImageReader, связанного с этим поставщиком сервиса, можно получить, вызвав метод createReaderInstance. Любые ресурсоёмкие операции инициализации, такие как загрузка нативных библиотек или создание больших таблиц, должны быть отложены как минимум до первого вызова этого метода.

Поля

STANDARD_INPUT_TYPE

@Deprecated
public static final Class[] STANDARD_INPUT_TYPE

Устаревшее. Вместо использования этого поля, напрямую создайте эквивалентный массив { ImageInputStream.class }.

Одноэлементный массив, изначально содержащий ImageInputStream.class, который должен возвращаться из getInputTypes.

inputTypes

protected Class[] inputTypes

Массив объектов Class для возврата из getInputTypes, изначально null.

writerSpiNames

protected String[] writerSpiNames

Массив строк, возвращаемый из getImageWriterSpiNames, изначально null.

Конструкторы

ImageReaderSpi

protected ImageReaderSpi()

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

ImageReaderSpi

public ImageReaderSpi(String vendorName,
                      String version,
                      String[] names,
                      String[] suffixes,
                      String[] MIMETypes,
                      String readerClassName,
                      Class[] inputTypes,
                      String[] writerSpiNames,
                      boolean supportsStandardStreamMetadataFormat,
                      String nativeStreamMetadataFormatName,
                      String nativeStreamMetadataFormatClassName,
                      String[] extraStreamMetadataFormatNames,
                      String[] extraStreamMetadataFormatClassNames,
                      boolean supportsStandardImageMetadataFormat,
                      String nativeImageMetadataFormatName,
                      String nativeImageMetadataFormatClassName,
                      String[] extraImageMetadataFormatNames,
                      String[] extraImageMetadataFormatClassNames)

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

Параметры:

vendorName — имя поставщика, как не-null String.

version — идентификатор версии, как не-null String.

names — не-null массив String, указывающий имена форматов. Должно быть присутствовать по крайней мере одно значение.

suffixes — массив String, указывающий общие расширения файлов. Если расширения не определены, следует использовать null. Массив длиной 0 будет нормализован до null.

MIMETypes — массив String, указывающий MIME-типы формата. Если MIME-типы не определены, следует использовать null. Массив длиной 0 будет нормализован до null.

readerClassName — полное имя связанного класса ImageReader, как не-null String.

inputTypes — не-null массив объектов Class длиной не менее 1, указывающий допустимые типы входных данных.

writerSpiNames — массив String, имя классов всех связанных ImageWriter или null. Массив длиной 0 нормализуется до null.

supportsStandardStreamMetadataFormat — значение, указывающее, может ли объект метаданных потока использовать деревья, описанные стандартным форматом метаданных.

nativeStreamMetadataFormatName — String, или null, который будет возвращаться из getNativeStreamMetadataFormatName.

nativeStreamMetadataFormatClassName — String, или null, используемый для создания объекта формата метаданных, который будет возвращаться из getNativeStreamMetadataFormat.

extraStreamMetadataFormatNames — массив String или null, возвращаемый из getExtraStreamMetadataFormatNames Массив длиной 0 нормализуется до null.

extraStreamMetadataFormatClassNames — массив String или null, используемый для создания объекта формата метаданных, возвращаемого из getStreamMetadataFormat. Массив длиной 0 нормализуется до null.

supportsStandardImageMetadataFormat — значение, указывающее, может ли объект метаданных изображения использовать деревья, описанные стандартным форматом метаданных.

nativeImageMetadataFormatName — String, или null, который возвращается из getNativeImageMetadataFormatName.

nativeImageMetadataFormatClassName — String, или null, используемый для создания объекта формата метаданных, возвращаемого из getNativeImageMetadataFormat.

extraImageMetadataFormatNames — массив String для возврата из getExtraImageMetadataFormatNames. Массив длиной 0 нормализуется до null.

extraImageMetadataFormatClassNames — массив String или null, используемый для создания объекта формата метаданных, возвращаемого из getImageMetadataFormat. Массив длиной 0 нормализуется до null.

Исключения:

IllegalArgumentException — если vendorName имеет значение null.

IllegalArgumentException — если version имеет значение null.

IllegalArgumentException — если names имеет значение null или имеет длину 0.

IllegalArgumentException — если readerClassName имеет значение null.

IllegalArgumentException — если inputTypes имеет значение null или имеет длину 0.

Методы

getInputTypes

public Class[] getInputTypes()

Возвращает:

не-null массив объектов Class длиной не менее 1.

canDecodeInput

public abstract boolean canDecodeInput(Object source)
                                throws IOException

Параметры:

source — объект (обычно ImageInputStream), который необходимо декодировать.

Возвращает:

true , если этот поток, вероятно, может быть декодирован.

Исключения:

IllegalArgumentException — если source имеет значение null.

IOException — если происходит ошибка ввода-вывода при чтении потока.

createReaderInstance

public ImageReader createReaderInstance()
                                 throws IOException

Возвращает:

экземпляр ImageReader.

Исключения:

IOException — если произошла ошибка при загрузке, или инициализации класса ридера, или при создании или инициализации объекта ридера.

createReaderInstance

public abstract ImageReader createReaderInstance(Object extension)
                                          throws IOException

Параметры:

extension — объект расширения, специфичный для плагина, который может быть null.

Возвращает:

экземпляр ImageReader.

Исключения:

IOException — если попытка создания ридера завершается неудачей.

IllegalArgumentException — если конструктор ImageReader выбрасывает IllegalArgumentException , чтобы указать, что объект расширения не подходит.

isOwnReader

public boolean isOwnReader(ImageReader reader)

Параметры:

reader — экземпляр ImageReader.

Возвращает:

true , если reader распознан.

Исключения:

IllegalArgumentException — если reader имеет значение null.

getImageWriterSpiNames

public String[] getImageWriterSpiNames()

Возвращает:

массив String длиной не менее 1, содержащий имена ImageWriterSpi, или null.

См. также:

ImageIO.getImageWriter(ImageReader)