Класс ImageReaderWriterSpi

java.lang.Object

javax.imageio.spi.IIOServiceProvider

javax.imageio.spi.ImageReaderWriterSpi

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

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

public abstract class ImageReaderWriterSpi extends IIOServiceProvider

Суперкласс, содержащий переменные экземпляра и методы, общие для 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`.

Поля, объявленные в классе 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` для объектов метаданных потоков, создаваемых или используемых этим подключаемым модулем.

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

getDescription, getVendorName, getVersion, onDeregistration, onRegistration

Методы, объявленные в классе 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

Объект String, содержащий имя связанного класса подключаемого модуля; изначально null.

supportsStandardStreamMetadataFormat

protected boolean supportsStandardStreamMetadataFormat

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

nativeStreamMetadataFormatName

protected String nativeStreamMetadataFormatName

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

nativeStreamMetadataFormatClassName

protected String nativeStreamMetadataFormatClassName

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

extraStreamMetadataFormatNames

protected String[] extraStreamMetadataFormatNames

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

extraStreamMetadataFormatClassNames

protected String[] extraStreamMetadataFormatClassNames

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

supportsStandardImageMetadataFormat

protected boolean supportsStandardImageMetadataFormat

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

nativeImageMetadataFormatName

protected String nativeImageMetadataFormatName

nativeImageMetadataFormatClassName

protected String nativeImageMetadataFormatClassName

extraImageMetadataFormatNames

protected String[] extraImageMetadataFormatNames

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

extraImageMetadataFormatClassNames

protected String[] extraImageMetadataFormatClassNames

Массив String, содержащий имена классов дополнительных форматов метаданных изображений, поддерживаемых этим подключаемым модулем; изначально 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 String, указывающий имена форматов. Должна присутствовать хотя бы одна запись.; suffixes — массив String, указывающий распространенные расширения файлов. Если расширения не определены, следует указать null. Массив нулевой длины будет нормализован до null.; MIMETypes — массив String, указывающий типы MIME формата. Если типы MIME не определены, следует указать null. Массив нулевой длины будет нормализован до null.; pluginClassName — полное имя связанного класса ImageReader или ImageWriter в виде ненулевого null String.; supportsStandardStreamMetadataFormat — объект boolean, указывающий, может ли объект метаданных потока использовать деревья, описанные стандартным форматом метаданных.; nativeStreamMetadataFormatName — объект String или null, возвращаемый методом getNativeStreamMetadataFormatName.; nativeStreamMetadataFormatClassName — объект String или null, используемый для создания объекта формата метаданных, возвращаемого методом getNativeStreamMetadataFormat.; extraStreamMetadataFormatNames — массив String или null, возвращаемый методом getExtraStreamMetadataFormatNames. Массив нулевой длины нормализуется до null.; extraStreamMetadataFormatClassNames — массив String или null, используемый для создания объекта формата метаданных, возвращаемого методом getStreamMetadataFormat. Массив нулевой длины нормализуется до null.; supportsStandardImageMetadataFormat — объект boolean, указывающий, может ли объект метаданных изображения использовать деревья, описанные стандартным форматом метаданных.; nativeImageMetadataFormatName — объект String или null, возвращаемый методом getNativeImageMetadataFormatName.; nativeImageMetadataFormatClassName — объект String или null, используемый для создания объекта формата метаданных, возвращаемого методом getNativeImageMetadataFormat.; extraImageMetadataFormatNames — массив String, возвращаемый методом getExtraImageMetadataFormatNames. Массив нулевой длины нормализуется до null.; extraImageMetadataFormatClassNames — массив String или null, используемый для создания объекта формата метаданных, возвращаемого методом getImageMetadataFormat. Массив нулевой длины нормализуется до null.
Вызывает исключения:: IllegalArgumentException — если vendorName равно null.; IllegalArgumentException — если version равно null.; IllegalArgumentException — если names равно null или имеет нулевую длину.; 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.

См. также:

isStandardImageMetadataFormatSupported

public boolean isStandardImageMetadataFormatSupported()

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

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

getNativeImageMetadataFormatName

public String getNativeImageMetadataFormatName()

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

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

Возвращает:

имя собственного формата метаданных изображения или null.

См. также:

getExtraImageMetadataFormatNames

public String[] getExtraImageMetadataFormatNames()

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

Если подключаемый модуль не обрабатывает метаданные изображений, следует вернуть null.

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

Возвращает:

массив String или null.

См. также:

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, 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/ImageReaderWriterSpi.html