Класс 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 с заданными значениями.

Методы

Модификатор и тип Метод Описание
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. Конструкторы должны задавать для него не-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 String.
names - массив, не-null строки, указывающие имена форматов. Должно быть, как минимум, одно значение.
suffixes - массив строк, указывающий общие расширения файлов. Если расширения не определены, должен быть передан null. Массив длиной 0 будет нормализован до null.
MIMETypes - массив строк, указывающий MIME типы формата. Если MIME типы не определены, должен быть передан null. Массив длиной 0 будет нормализован до null.
pluginClassName - полное имя связанного класса ImageReader или ImageWriter, в виде не-null String строки.
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 равно null.
IllegalArgumentException - если version равно null.
IllegalArgumentException - если names равно null или имеет длину 0.
IllegalArgumentException - если pluginClassName равно null.

ImageReaderWriterSpi

public ImageReaderWriterSpi()

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

Методы

getFormatNames

public String[] getFormatNames()

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

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

getFileSuffixes

public String[] getFileSuffixes()

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

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

Возвращает:
массив String или длиной не менее 1, содержащий распространённые расширения файлов, связанные с этим чтецом или записывателем, или null.

getMIMETypes

public String[] getMIMETypes()

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

Возвращает:
массив String или длиной не менее 1, содержащий типы MIME, связанные с этим чтецом или записывателем, или null.

getPluginClassName

public String getPluginClassName()

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

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

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

Spec-Zone .ru
спецификации, руководства, описания, API