Spec-Zone.ru › OpenJDK 24

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

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

Модификатор и тип Метод Описание
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 массив String, указывающий имена форматов. Должен содержать хотя бы один элемент.
suffixes - массив String, указывающий общие расширения файлов. Если расширения не определены, должен быть указан null. Массив длиной 0 будет нормализован до null.
MIMETypes - массив String, указывающий 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, 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/imageio/spi/ImageReaderWriterSpi.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API