Класс ImageReaderWriterSpi

java.lang.Object
- javax.imageio.spi.IIOServiceProvider
- - javax.imageio.spi.ImageReaderWriterSpi

Все реализованные интерфейсы:: RegisterableService

Непосредственные известные подклассы:: ImageReaderSpi, ImageWriterSpi

public abstract class ImageReaderWriterSpi
extends IIOServiceProvider

Базовый класс, содержащий переменные экземпляра и методы, общие для ImageReaderSpi и ImageWriterSpi.

См. также:: IIORegistry, ImageReaderSpi, ImageWriterSpi

Поля

Модификатор и тип	Поле и описание
`protected String[]`	`extraImageMetadataFormatClassNames` Массив `String` содержащий имена классов дополнительных форматов метаданных изображений, поддерживаемых этим плагином, изначально `null`.
`protected String[]`	`extraImageMetadataFormatNames` Массив `String` содержащий имена дополнительных форматов метаданных изображений, поддерживаемых этим плагином, изначально `null`.
`protected String[]`	`extraStreamMetadataFormatClassNames` Массив `String` содержащий имена классов дополнительных форматов метаданных потока, поддерживаемых этим плагином, изначально `null`.
`protected String[]`	`extraStreamMetadataFormatNames` Массив `String` содержащий имена дополнительных форматов метаданных потока, поддерживаемых этим плагином, изначально `null`.
`protected String[]`	`MIMETypes` Массив строк, возвращаемых методом `getMIMETypes`, изначально `null`.
`protected String[]`	`names` Массив строк, возвращаемых методом `getFormatNames`, изначально `null`.
`protected String`	`nativeImageMetadataFormatClassName` `String` содержащий имя класса родного формата метаданных потока, поддерживаемого этим плагином, изначально `null`.
`protected String`	`nativeImageMetadataFormatName` `String` содержащий имя родного формата метаданных потока, поддерживаемого этим плагином, изначально `null`.
`protected String`	`nativeStreamMetadataFormatClassName` `String` содержащий имя класса родного формата метаданных потока, поддерживаемого этим плагином, изначально `null`.
`protected String`	`nativeStreamMetadataFormatName` `String` содержащий имя родного формата метаданных потока, поддерживаемого этим плагином, изначально `null`.
`protected String`	`pluginClassName` `String` содержащий имя ассоциированного класса плагина, изначально `null`.
`protected String[]`	`suffixes` Массив строк, возвращаемых методом `getFileSuffixes`, изначально `null`.
`protected boolean`	`supportsStandardImageMetadataFormat` Булево значение, указывающее, поддерживает ли этот плагин стандартный формат метаданных для метаданных изображений, изначально `false`.
`protected boolean`	`supportsStandardStreamMetadataFormat` Булево значение, указывающее, поддерживает ли этот плагин стандартный формат метаданных для метаданных потока, изначально `false`.

Поля унаследованные от класса javax.imageio.spi.IIOServiceProvider

vendorName, version

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

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

Конструктор и описание
`ImageReaderWriterSpi()` Создаёт пустой `ImageReaderWriterSpi`.
ImageReaderWriterSpi(String vendorName, String version, String[] names, String[] suffixes, String[] MIMETypes, String pluginClassName, boolean supportsStandardStreamMetadataFormat, String nativeStreamMetadataFormatName, String nativeStreamMetadataFormatClassName, String[] extraStreamMetadataFormatNames, String[] extraStreamMetadataFormatClassNames, boolean supportsStandardImageMetadataFormat, String nativeImageMetadataFormatName, String nativeImageMetadataFormatClassName, String[] extraImageMetadataFormatNames, String[] extraImageMetadataFormatClassNames) Создаёт `ImageReaderWriterSpi` с заданными значениями.

ImageReaderWriterSpi()

Создаёт пустой ImageReaderWriterSpi.

ImageReaderWriterSpi(String vendorName,
                    String version,
                    String[] names,
                    String[] suffixes,
                    String[] MIMETypes,
                    String pluginClassName,
                    boolean supportsStandardStreamMetadataFormat,
                    String nativeStreamMetadataFormatName,
                    String nativeStreamMetadataFormatClassName,
                    String[] extraStreamMetadataFormatNames,
                    String[] extraStreamMetadataFormatClassNames,
                    boolean supportsStandardImageMetadataFormat,
                    String nativeImageMetadataFormatName,
                    String nativeImageMetadataFormatClassName,
                    String[] extraImageMetadataFormatNames,
                    String[] extraImageMetadataFormatClassNames)

Создаёт ImageReaderWriterSpi с заданными значениями.

Методы

Модификатор и тип	Метод и описание
`String[]`	`getExtraImageMetadataFormatNames()` Возвращает массив `String` содержащий имена дополнительных форматов документов, отличных от родного и стандартного, распознаваемых методами `getAsTree` и `setFromTree` на объектах метаданных изображений, производимых или потребляемых этим плагином.
`String[]`	`getExtraStreamMetadataFormatNames()` Возвращает массив `String` содержащий имена дополнительных форматов документов, отличных от родного и стандартного, распознаваемых методами `getAsTree` и `setFromTree` на объектах метаданных потока, производимых или потребляемых этим плагином.
`String[]`	`getFileSuffixes()` Возвращает массив `String` содержащий список расширений файлов, связанных с форматами, которые, как правило, могут быть использованы реализацией `ImageReader` или `ImageWriter` связанной с этим поставщиком сервиса.
`String[]`	`getFormatNames()` Возвращает массив `String` содержащий удобочитаемые имена форматов, которые, как правило, могут быть использованы реализацией `ImageReader` или `ImageWriter` связанной с этим поставщиком сервиса.
`IIOMetadataFormat`	`getImageMetadataFormat(String formatName)` Возвращает объект `IIOMetadataFormat` описывающий заданный формат метаданных изображения, или `null` если описание недоступно.
`String[]`	`getMIMETypes()` Возвращает массив `String` содержащий список MIME-типов, связанных с форматами, которые, как правило, могут быть использованы реализацией `ImageReader` или `ImageWriter` связанной с этим поставщиком сервиса.
`String`	`getNativeImageMetadataFormatName()` Возвращает имя "родного" формата метаданных изображения для этого плагина, который обычно позволяет без потерь кодировать и передавать метаданные изображения, хранящиеся в формате, обрабатываемом этим плагином.
`String`	`getNativeStreamMetadataFormatName()` Возвращает имя "родного" формата метаданных потока для этого плагина, который обычно позволяет без потерь кодировать и передавать метаданные потока, хранящиеся в формате, обрабатываемом этим плагином.
`String`	`getPluginClassName()` Возвращает полное имя класса плагина `ImageReader` или `ImageWriter` связанного с этим поставщиком сервиса.
`IIOMetadataFormat`	`getStreamMetadataFormat(String formatName)` Возвращает объект `IIOMetadataFormat` описывающий заданный формат метаданных потока, или `null` если описание недоступно.
`boolean`	`isStandardImageMetadataFormatSupported()` Возвращает `true` если стандартный формат метаданных находится среди форматов документов, распознаваемых методами `getAsTree` и `setFromTree` на объектах метаданных изображений, производимых или потребляемых этим плагином.
`boolean`	`isStandardStreamMetadataFormatSupported()` Возвращает `true` если стандартный формат метаданных находится среди форматов документов, распознаваемых методами `getAsTree` и `setFromTree` на объектах метаданных потока, производимых или потребляемых этим плагином.

Методы унаследованные от класса javax.imageio.spi.IIOServiceProvider

getDescription, getVendorName, getVersion, onDeregistration, onRegistration

Методы унаследованные от класса java.lang.Object

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

Поля

names

protected String[] names

Массив строк, возвращаемых из getFormatNames, по умолчанию null. Конструкторы должны установить его на ненулевое значение.

suffixes

protected String[] suffixes

Массив строк, возвращаемых из getFileSuffixes, по умолчанию null.

MIMETypes

protected String[] MIMETypes

Массив строк, возвращаемых из getMIMETypes, по умолчанию null.

pluginClassName

protected String pluginClassName

Строка, содержащая имя связанного класса плагина, по умолчанию null.

supportsStandardStreamMetadataFormat

protected boolean supportsStandardStreamMetadataFormat

Булево значение, указывающее, поддерживает ли этот плагин стандартный формат метаданных потока, по умолчанию false.

nativeStreamMetadataFormatName

protected String nativeStreamMetadataFormatName

Строка, содержащая имя родного формата метаданных потока, поддерживаемого этим плагином, по умолчанию null.

nativeStreamMetadataFormatClassName

protected String nativeStreamMetadataFormatClassName

Строка, содержащая имя класса родного формата метаданных потока, поддерживаемого этим плагином, по умолчанию null.

extraStreamMetadataFormatNames

protected String[] extraStreamMetadataFormatNames

Массив строк, содержащих имена дополнительных форматов метаданных потока, поддерживаемых этим плагином, по умолчанию null.

extraStreamMetadataFormatClassNames

protected String[] extraStreamMetadataFormatClassNames

Массив строк, содержащих имена классов дополнительных форматов метаданных потока, поддерживаемых этим плагином, по умолчанию null.

supportsStandardImageMetadataFormat

protected boolean supportsStandardImageMetadataFormat

Булево значение, указывающее, поддерживает ли этот плагин стандартный формат метаданных для изображений, по умолчанию false.

nativeImageMetadataFormatName

protected String nativeImageMetadataFormatName

Строка, содержащая имя родного формата метаданных изображения, поддерживаемого этим плагином, по умолчанию null.

nativeImageMetadataFormatClassName

protected String nativeImageMetadataFormatClassName

Строка, содержащая имя класса родного формата метаданных изображения, поддерживаемого этим плагином, по умолчанию null.

extraImageMetadataFormatNames

protected String[] extraImageMetadataFormatNames

Массив строк, содержащих имена любых дополнительных форматов метаданных изображений, поддерживаемых этим плагином, по умолчанию null.

extraImageMetadataFormatClassNames

protected String[] extraImageMetadataFormatClassNames

Массив строк, содержащих имена классов любых дополнительных форматов метаданных изображений, поддерживаемых этим плагином, по умолчанию null.

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

ImageReaderWriterSpi

public ImageReaderWriterSpi(String vendorName,
                            String version,
                            String[] names,
                            String[] suffixes,
                            String[] MIMETypes,
                            String pluginClassName,
                            boolean supportsStandardStreamMetadataFormat,
                            String nativeStreamMetadataFormatName,
                            String nativeStreamMetadataFormatClassName,
                            String[] extraStreamMetadataFormatNames,
                            String[] extraStreamMetadataFormatClassNames,
                            boolean supportsStandardImageMetadataFormat,
                            String nativeImageMetadataFormatName,
                            String nativeImageMetadataFormatClassName,
                            String[] extraImageMetadataFormatNames,
                            String[] extraImageMetadataFormatClassNames)

Создаёт объект ImageReaderWriterSpi с заданными значениями.

Параметры:: vendorName - имя производителя, как непустая строка.; null - идентификатор версии, как непустая строка.; String - массив строк, обозначающих имена форматов. Необходимо наличие хотя бы одного элемента.; version - массив строк, обозначающих общие расширения файлов. Если расширения не определены, следует передать null. Массив длиной 0 будет нормализован до null.; names - массив строк, обозначающих MIME-типы формата. Если MIME-типы не определены, следует передать null. Массив длиной 0 будет нормализован до null.; pluginClassName - полное имя связанного класса ImageReader или ImageWriter, как непустая строка.; supportsStandardStreamMetadataFormat - булево значение, указывающее, может ли объект метаданных потока использовать деревья, описанные стандартным форматом метаданных.; nativeStreamMetadataFormatName - строка, или null, возвращаемая из getNativeStreamMetadataFormatName.; nativeStreamMetadataFormatClassName - строка, или null, для создания объекта формата метаданных, возвращаемого из getNativeStreamMetadataFormat.; extraStreamMetadataFormatNames - массив строк, или null, возвращаемых из getExtraStreamMetadataFormatNames. Массив длиной 0 нормализуется до null.; extraStreamMetadataFormatClassNames - массив строк, или null, для создания объекта формата метаданных, возвращаемого из getStreamMetadataFormat. Массив длиной 0 нормализуется до null.; supportsStandardImageMetadataFormat - булево значение, указывающее, может ли объект метаданных изображения использовать деревья, описанные стандартным форматом метаданных.; nativeImageMetadataFormatName - строка, или null, возвращаемая из getNativeImageMetadataFormatName.; nativeImageMetadataFormatClassName - строка, или null, для создания объекта формата метаданных, возвращаемого из getNativeImageMetadataFormat.; extraImageMetadataFormatNames - массив строк, возвращаемых из getExtraImageMetadataFormatNames. Массив длиной 0 нормализуется до null.; extraImageMetadataFormatClassNames - массив строк, или null, для создания объекта формата метаданных, возвращаемого из getImageMetadataFormat. Массив длиной 0 нормализуется до null.
Исключения:: IllegalArgumentException - если vendorName пустая.; IllegalArgumentException - если version пустая.; IllegalArgumentException - если names пустой или имеет длину 0.; IllegalArgumentException - если pluginClassName пустая.

ImageReaderWriterSpi

public ImageReaderWriterSpi()

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

Методы

getFormatNames

public String[] getFormatNames()

Возвращает массив строк, содержащих удобочитаемые имена форматов, которые в целом могут использоваться реализацией ImageReader или ImageWriter поставщика услуг. Например, один ImageReader может обрабатывать файлы PBM и PNM.

Возвращает:: непустой массив строк, содержащий неофициальные имена форматов, связанные с этим читателем или писателем.

getFileSuffixes

public String[] getFileSuffixes()

Возвращает массив строк, содержащий список расширений файлов, связанных с форматами, которые в целом могут использоваться реализацией ImageReader или ImageWriter поставщика услуг. Например, один ImageReader может обрабатывать файлы с расширениями '.pbm' и '.pnm' или '.jpg' и '.jpeg'. Если известных расширений файлов нет, возвращается null.

Возврат определенного расширения не гарантирует, что файлы с этим расширением можно обработать; это просто указывает, что стоит попытаться декодировать или закодировать такие файлы с помощью этого поставщика услуг.

Возвращает:: массив строк или null.

getMIMETypes

public String[] getMIMETypes()

Возвращает массив строк, содержащий список MIME-типов, связанных с форматами, которые в целом могут использоваться реализацией ImageReader или ImageWriter поставщика услуг.

В идеале для описания конкретного формата потребовался бы только один MIME-тип. Однако по нескольким причинам необходимо связывать список типов с каждым поставщиком услуг. Во-первых, многие распространённые форматы файлов изображений не имеют стандартных MIME-типов, поэтому потребуется список обычно используемых неофициальных имён, таких как image/x-pbm и image/x-portable-bitmap. Некоторые форматы файлов имеют официальные MIME-типы, но иногда к ним обращаются по предыдущим неофициальным обозначениям, таким как image/x-png вместо официального image/png. Наконец, один поставщик услуг может быть способен анализировать несколько различных типов с точки зрения MIME, например, image/x-xbitmap и image/x-xpixmap.

Возврат определённого MIME-типа не гарантирует, что файлы, заявившие о таком типе, можно обработать; это просто указывает, что стоит попытаться декодировать или закодировать такие файлы с помощью этого поставщика услуг.

Возвращает:: массив строк или null.

getPluginClassName

public String getPluginClassName()

Возвращает полное имя класса плагина ImageReader или ImageWriter, связанного с этим поставщиком услуг.

Возвращает:: имя класса как непустую строку.

isStandardStreamMetadataFormatSupported

public boolean isStandardStreamMetadataFormatSupported()

Возвращает значение true, если стандартный формат метаданных находится среди форматов документов, распознаваемых методами getAsTree и setFromTree на объектах метаданных потока, создаваемых или потребляемых этим плагином.

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

getNativeStreamMetadataFormatName

public String getNativeStreamMetadataFormatName()

Возвращает имя формата метаданных "родного" потока для этого плагина, который, как правило, позволяет бес потерь кодировать и передавать метаданные потока, хранящиеся в формате, обрабатываемом этим плагином. Если такой формат не поддерживается, возвращается null.

Реализация по умолчанию возвращает переменную nativeStreamMetadataFormatName, которая обычно устанавливается конструктором.

Возвращает:: имя формата родных метаданных потока или null.

getExtraStreamMetadataFormatNames

public String[] getExtraStreamMetadataFormatNames()

Возвращает массив String содержащий имена дополнительных форматов документов, помимо родного и стандартного форматов, распознаваемых методами getAsTree и setFromTree для объектов метаданных потока, создаваемых или потребляемых этим плагином.

Если плагин не обрабатывает метаданные, должен быть возвращен null.

Набор форматов может отличаться в зависимости от конкретных изображений, которые читаются или записываются; этот метод должен указывать все дополнительные форматы, поддерживаемые плагином при любых обстоятельствах.

Реализация по умолчанию возвращает копию переменной extraStreamMetadataFormatNames, которая обычно устанавливается конструктором.

Возвращает:: массив String или null.
См. также:: IIOMetadata.getMetadataFormatNames(), getExtraImageMetadataFormatNames(), getNativeStreamMetadataFormatName()

isStandardImageMetadataFormatSupported

public boolean isStandardImageMetadataFormatSupported()

Возвращает true если стандартный формат метаданных среди форматов документов, распознаваемых методами getAsTree и setFromTree для объектов метаданных изображения, создаваемых или потребляемых этим плагином.

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

getNativeImageMetadataFormatName

public String getNativeImageMetadataFormatName()

Возвращает имя формата метаданных "родного" изображения для этого плагина, который, как правило, позволяет бес потерь кодировать и передавать метаданные изображения, хранящиеся в формате, обрабатываемом этим плагином. Если такой формат не поддерживается, возвращается null.

Реализация по умолчанию возвращает переменную nativeImageMetadataFormatName, которая обычно устанавливается конструктором.

Возвращает:: имя формата родных метаданных изображения или null.
См. также:: getExtraImageMetadataFormatNames()

getExtraImageMetadataFormatNames

public String[] getExtraImageMetadataFormatNames()

Возвращает массив String содержащий имена дополнительных форматов документов, помимо родного и стандартного форматов, распознаваемых методами getAsTree и setFromTree для объектов метаданных изображения, создаваемых или потребляемых этим плагином.

Если плагин не обрабатывает метаданные изображения, должен быть возвращен null.

Реализация по умолчанию возвращает копию переменной extraImageMetadataFormatNames, которая обычно устанавливается конструктором.

Возвращает:: массив String или null.
См. также:: IIOMetadata.getMetadataFormatNames(), getExtraStreamMetadataFormatNames(), getNativeImageMetadataFormatName()

getStreamMetadataFormat

public IIOMetadataFormat getStreamMetadataFormat(String formatName)

Возвращает объект IIOMetadataFormat описывающий заданный формат метаданных потока, или null если описание недоступно. Указанное имя должно быть именем родного формата метаданных потока, именем стандартного формата метаданных или одним из тех, что возвращаются getExtraStreamMetadataFormatNames.

Параметры:: formatName - желаемый формат метаданных потока.
Возвращает:: объект IIOMetadataFormat.
Исключения:: IllegalArgumentException - если formatName null или не является поддерживаемым именем.

getImageMetadataFormat

public IIOMetadataFormat getImageMetadataFormat(String formatName)

Возвращает объект IIOMetadataFormat описывающий заданный формат метаданных изображения, или null если описание недоступно. Указанное имя должно быть именем родного формата метаданных изображения, именем стандартного формата метаданных или одним из тех, что возвращаются getExtraImageMetadataFormatNames.

Параметры:: formatName - желаемый формат метаданных изображения.
Возвращает:: объект IIOMetadataFormat.
Исключения:: IllegalArgumentException - если formatName null или не является поддерживаемым именем.

© 1993, 2020, 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.