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

Модификатор и тип	Поле	Описание
`protected String`	`vendorName`	Объект `String`, возвращаемый из `getVendorName`; изначально `null`.
`protected String`	`version`	Объект `String`, возвращаемый из `getVersion`; изначально null.

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

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

Конструктор	Описание
`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

Модификатор и тип	Метод	Описание
`abstract String`	`getDescription(Locale locale)`	Возвращает краткое понятное человеку описание этого поставщика службы и связанной с ним реализации.
`String`	`getVendorName()`	Возвращает имя поставщика, ответственного за создание этого поставщика службы и связанной с ним реализации.
`String`	`getVersion()`	Возвращает строку с номером версии этого поставщика службы и связанной с ним реализации.
`void`	`onDeregistration(ServiceRegistry registry, Class<?> category)`	Функция обратного вызова, которая вызывается при удалении регистрации класса Spi из `ServiceRegistry`.
`void`	`onRegistration(ServiceRegistry registry, Class<?> category)`	Функция обратного вызова, которая вызывается ровно один раз после создания экземпляра класса Spi и его регистрации в `ServiceRegistry`.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API может быть удален в будущей версии. Финализация объявлена устаревшей и может быть удалена в одном из следующих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

Подробное описание полей

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.

Возвращает:: массив String, не равный null, длиной не менее 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.