Spec-Zone.ru › OpenJDK 27

Класс IIOMetadata

java.lang.Object
javax.imageio.metadata.IIOMetadata
public abstract class IIOMetadata extends Object
Абстрактный класс, который расширяют объекты, представляющие метаданные (данные, не являющиеся изображением), связанные с изображениями и потоками. Плагины представляют метаданные с помощью непрозрачных объектов, специфичных для плагина. Однако эти объекты предоставляют возможность доступа к содержащейся в них информации в виде дерева объектов IIOMetadataNode, поддерживающих интерфейсы XML DOM, а также дополнительные интерфейсы для хранения нетекстовых данных и получения сведений о допустимых значениях данных. Формат таких деревьев зависит от плагина, однако плагины могут поддерживать нейтральный по отношению к плагинам формат, описанный ниже. Один плагин может поддерживать несколько форматов метаданных, имена которых можно определить, вызвав getMetadataFormatNames. Плагин также может поддерживать один специальный формат, называемый «родным», который предназначен для кодирования метаданных без потерь. Обычно этот формат создаётся специально для работы с определённым форматом файла, чтобы изображения можно было загружать и сохранять в том же формате без потери метаданных, однако он может быть менее полезен для переноса метаданных между ImageReader и ImageWriter для разных форматов изображений. Для преобразования между двумя родными форматами с минимальными потерями, допускаемыми форматами файлов изображений, необходимо использовать объект ImageTranscoder.
См. также:
  • ImageReader.getImageMetadata(int)
  • ImageReader.getStreamMetadata()
  • ImageReader.readAll(int, ImageReadParam)
  • ImageWriter.getDefaultStreamMetadata(ImageWriteParam)
  • ImageWriter.getDefaultImageMetadata(ImageTypeSpecifier, ImageWriteParam)
  • ImageWriter.write(IIOMetadata, IIOImage, ImageWriteParam)
  • ImageTranscoder.convertImageMetadata(IIOMetadata, ImageTypeSpecifier, ImageWriteParam)
  • ImageTranscoder.convertStreamMetadata(IIOMetadata, ImageWriteParam)
  • IIOImage
  • ImageTranscoder

Краткое описание полей

Модификатор и тип Поле Описание
protected IIOMetadataController controller
IIOMetadataController, который будет использоваться для задания параметров этого объекта IIOMetadata при вызове метода activateController.
protected IIOMetadataController defaultController
Объект IIOMetadataController, предлагаемый для использования в качестве контроллера этого объекта IIOMetadata.
protected String[] extraMetadataFormatClassNames
Массив имён классов, реализующих IIOMetadataFormat и представляющих форматы метаданных, отличные от стандартного и родного форматов, поддерживаемые этим плагином; инициализируется значением null и задаётся конструктором.
protected String[] extraMetadataFormatNames
Массив имён форматов, отличных от стандартного и родного форматов, поддерживаемых этим плагином; инициализируется значением null и задаётся конструктором.
protected String nativeMetadataFormatClassName
Имя класса, реализующего IIOMetadataFormat и представляющего родной формат метаданных; инициализируется значением null и задаётся конструктором.
protected String nativeMetadataFormatName
Имя родного формата метаданных для этого объекта; инициализируется значением null и задаётся конструктором.
protected boolean standardFormatSupported
Логическое значение, указывающее, поддерживает ли конкретный подкласс стандартный формат метаданных; задаётся конструктором.

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

IIOMetadata()
IIOMetadata(boolean standardMetadataFormatSupported, String nativeMetadataFormatName, String nativeMetadataFormatClassName, String[] extraMetadataFormatNames, String[] extraMetadataFormatClassNames)
Модификатор Конструктор Описание
protected
Создаёт пустой объект IIOMetadata.
protected
Создаёт объект IIOMetadata с заданными именами форматов и именами классов форматов, а также с логическим значением, указывающим, поддерживается ли стандартный формат.

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

Модификатор и тип Метод Описание
boolean activateController()
Активирует установленный IIOMetadataController для этого объекта IIOMetadata и возвращает полученное значение.
abstract Node getAsTree(String formatName)
Возвращает объект Node XML DOM, представляющий корень дерева метаданных, содержащихся в этом объекте, в соответствии с соглашениями, определёнными заданным форматом метаданных.
IIOMetadataController getController()
Возвращает текущий установленный IIOMetadataController.
IIOMetadataController getDefaultController()
Возвращает IIOMetadataController по умолчанию, если он есть, независимо от текущего установленного контроллера.
String[] getExtraMetadataFormatNames()
Возвращает массив String, содержащих имена дополнительных форматов метаданных, кроме родного и стандартного форматов, распознаваемых методами getAsTree, setFromTree и mergeTree этого плагина.
IIOMetadataFormat getMetadataFormat(String formatName)
Возвращает объект IIOMetadataFormat с описанием заданного формата метаданных или null, если описание недоступно.
String[] getMetadataFormatNames()
Возвращает массив String, содержащих имена всех форматов метаданных, включая родной и стандартный форматы, распознаваемых методами getAsTree, setFromTree и mergeTree этого плагина.
String getNativeMetadataFormatName()
Возвращает имя «родного» формата метаданных этого плагина, который обычно позволяет кодировать и передавать без потерь метаданные, хранящиеся в формате, обрабатываемом этим плагином.
protected IIOMetadataNode getStandardChromaNode()
Возвращает объект IIOMetadataNode, представляющий информацию о цветности стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна.
protected IIOMetadataNode getStandardCompressionNode()
Возвращает объект IIOMetadataNode, представляющий информацию о сжатии стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна.
protected IIOMetadataNode getStandardDataNode()
Возвращает объект IIOMetadataNode, представляющий информацию о формате данных стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна.
protected IIOMetadataNode getStandardDimensionNode()
Возвращает объект IIOMetadataNode, представляющий информацию о размерах стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна.
protected IIOMetadataNode getStandardDocumentNode()
Возвращает объект IIOMetadataNode, представляющий информацию о документе стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна.
protected IIOMetadataNode getStandardTextNode()
Возвращает объект IIOMetadataNode, представляющий текстовую информацию стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна.
protected IIOMetadataNode getStandardTileNode()
Возвращает объект IIOMetadataNode, представляющий информацию о разбиении на блоки стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна.
protected IIOMetadataNode getStandardTransparencyNode()
Возвращает объект IIOMetadataNode, представляющий информацию о прозрачности стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна.
protected final IIOMetadataNode getStandardTree()
Вспомогательный метод, возвращающий дерево IIOMetadataNode, представляющих метаданные, содержащиеся в этом объекте, в соответствии с соглашениями стандартного формата метаданных javax_imageio_1.0.
boolean hasController()
Возвращает true, если для этого объекта IIOMetadata установлен контроллер.
abstract boolean isReadOnly()
Возвращает true, если этот объект не поддерживает методы mergeTree, setFromTree и reset.
boolean isStandardMetadataFormatSupported()
Возвращает true, если методы getMetadataFormat, getAsTree, setFromTree и mergeTree поддерживают стандартный формат метаданных.
abstract void mergeTree(String formatName, Node root)
Изменяет внутреннее состояние этого объекта IIOMetadata на основе дерева объектов Node XML DOM, синтаксис которого определён заданным форматом метаданных.
abstract void reset()
Сбрасывает все данные, хранящиеся в этом объекте, до значений по умолчанию — обычно до состояния, в котором объект находился сразу после создания, хотя точная семантика зависит от плагина.
void setController(IIOMetadataController controller)
Задаёт IIOMetadataController, который будет использоваться для задания параметров этого объекта IIOMetadata при вызове метода activateController, заменяя любой контроллер по умолчанию.
void setFromTree(String formatName, Node root)
Задаёт внутреннее состояние этого объекта IIOMetadata на основе дерева объектов Node XML DOM, синтаксис которого определён заданным форматом метаданных.

Методы, объявленные в классе 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, либо истечения заданного промежутка реального времени.

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

standardFormatSupported

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

nativeMetadataFormatName

protected String nativeMetadataFormatName
Имя собственного формата метаданных этого объекта; инициализируется значением null и задаётся через конструктор.

nativeMetadataFormatClassName

protected String nativeMetadataFormatClassName
Имя класса, реализующего IIOMetadataFormat и представляющего собственный формат метаданных; инициализируется значением null и задаётся через конструктор.

extraMetadataFormatNames

protected String[] extraMetadataFormatNames
Массив имён форматов, отличных от стандартного и собственного, которые поддерживаются этим подключаемым модулем; инициализируется значением null и задаётся через конструктор.

extraMetadataFormatClassNames

protected String[] extraMetadataFormatClassNames
Массив имён классов, реализующих IIOMetadataFormat и представляющих форматы метаданных, отличные от стандартного и собственного, которые поддерживаются этим подключаемым модулем; инициализируется значением null и задаётся через конструктор.

defaultController

protected IIOMetadataController defaultController
Объект IIOMetadataController, предлагаемый для использования в качестве контроллера этого объекта IIOMetadata. Его можно получить с помощью getDefaultController. Чтобы установить контроллер по умолчанию, вызовите setController(getDefaultController()). Этот экземплярный член должен задаваться подклассами, которые предоставляют собственный контроллер по умолчанию, обычно графический интерфейс для установки параметров.
См. также:
  • IIOMetadataController
  • getDefaultController()

controller

protected IIOMetadataController controller
Объект IIOMetadataController, который будет использоваться для предоставления настроек этого объекта IIOMetadata при вызове метода activateController. Это значение переопределяет любой контроллер по умолчанию, даже если null.
См. также:
  • IIOMetadataController
  • setController(IIOMetadataController)
  • hasController()
  • activateController()

Подробное описание конструкторов

IIOMetadata

protected IIOMetadata()
Создаёт пустой объект IIOMetadata. Подкласс отвечает за предоставление значений всем защищённым экземплярным переменным, которые позволят любым не переопределённым реализациям методов по умолчанию соответствовать своим контрактам. Например, extraMetadataFormatNames не должен иметь длину 0.

IIOMetadata

protected IIOMetadata(boolean standardMetadataFormatSupported, String nativeMetadataFormatName, String nativeMetadataFormatClassName, String[] extraMetadataFormatNames, String[] extraMetadataFormatClassNames)
Создаёт объект IIOMetadata с заданными именами форматов и именами классов форматов, а также с логическим значением, указывающим, поддерживается ли стандартный формат.

Этот конструктор не пытается проверять правильность имён классов. Недопустимые имена классов могут привести к исключениям при последующих вызовах getMetadataFormat.

Параметры:
standardMetadataFormatSupported — true, если этот объект может возвращать или принимать дерево DOM в стандартном формате метаданных.
nativeMetadataFormatName — имя собственного формата метаданных в виде String или null, если собственного формата нет.
nativeMetadataFormatClassName — имя класса собственного формата метаданных или null, если собственного формата нет.
extraMetadataFormatNames — массив String, указывающих дополнительные форматы, поддерживаемые этим объектом, или null, если таких форматов нет.
extraMetadataFormatClassNames — массив String, указывающих имена классов любых дополнительных форматов, поддерживаемых этим объектом, или null, если таких форматов нет.
Исключения:
IllegalArgumentException — если длина extraMetadataFormatNames равна 0.
IllegalArgumentException — если extraMetadataFormatNames и extraMetadataFormatClassNames не являются одновременно null и имеют разную длину.

Подробное описание методов

isStandardMetadataFormatSupported

public boolean isStandardMetadataFormatSupported()
Возвращает true, если стандартный формат метаданных поддерживается объектами getMetadataFormat, getAsTree, setFromTree и mergeTree.

Реализация по умолчанию возвращает значение экземплярной переменной standardFormatSupported.

Возвращает:
true, если стандартный формат метаданных поддерживается.
См. также:
  • getAsTree(String)
  • setFromTree(String, Node)
  • mergeTree(String, Node)
  • getMetadataFormat(String)

isReadOnly

public abstract boolean isReadOnly()
Возвращает true, если этот объект не поддерживает методы mergeTree, setFromTree и reset.
Возвращает:
true, если этот объект IIOMetadata нельзя изменить.

getNativeMetadataFormatName

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

Структура и содержимое «собственного» формата метаданных определяются подключаемым модулем, создавшим этот объект IIOMetadata. Подключаемые модули для простых форматов обычно создают фиктивный корневой узел, а затем ряд дочерних узлов, представляющих отдельные теги, фрагменты или пары ключ/значение. Подключаемый модуль может самостоятельно решить, документировать ли свой собственный формат.

Реализация по умолчанию возвращает значение экземплярной переменной nativeMetadataFormatName.

Возвращает:
имя собственного формата или null.
См. также:
  • getExtraMetadataFormatNames()
  • getMetadataFormatNames()

getExtraMetadataFormatNames

public String[] getExtraMetadataFormatNames()
Возвращает массив String, содержащий имена дополнительных форматов метаданных, отличных от собственного и стандартного форматов, распознаваемых методами getAsTree, setFromTree и mergeTree подключаемого модуля. Если таких дополнительных форматов нет, возвращается null.

Реализация по умолчанию возвращает копию экземплярной переменной extraMetadataFormatNames.

Возвращает:
массив String длиной не менее 1 или null.
См. также:
  • getAsTree(String)
  • setFromTree(String, Node)
  • mergeTree(String, Node)
  • getNativeMetadataFormatName()
  • getMetadataFormatNames()

getMetadataFormatNames

public String[] getMetadataFormatNames()
Возвращает массив String, содержащий имена всех форматов метаданных, включая собственный и стандартный форматы, распознаваемых методами getAsTree, setFromTree и mergeTree подключаемого модуля. Если таких форматов нет, возвращается null.

Реализация по умолчанию вызывает getNativeMetadataFormatName, isStandardMetadataFormatSupported и getExtraMetadataFormatNames и возвращает объединённые результаты.

Возвращает:
массив String.
См. также:
  • getNativeMetadataFormatName()
  • isStandardMetadataFormatSupported()
  • getExtraMetadataFormatNames()

getMetadataFormat

public IIOMetadataFormat getMetadataFormat(String formatName)
Возвращает объект IIOMetadataFormat, описывающий заданный формат метаданных, или null, если описание недоступно. Указанное имя должно быть одним из имён, возвращаемых методом getMetadataFormatNames (т. е., именем собственного формата, именем стандартного формата или одним из имён, возвращаемых методом getExtraMetadataFormatNames).

Реализация по умолчанию сравнивает имя с глобальным именем стандартного формата метаданных и возвращает этот формат, если он поддерживается. В противном случае она проверяет имена собственного формата, а затем имена всех дополнительных форматов. Если найдено совпадение, она получает имя класса IIOMetadataFormat из nativeMetadataFormatClassName или extraMetadataFormatClassNames соответственно и создаёт экземпляр этого класса с помощью его метода getInstance.

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

getAsTree

public abstract Node getAsTree(String formatName)
Возвращает объект Node XML DOM, представляющий корень дерева метаданных, содержащихся в этом объекте, согласно соглашениям заданного формата метаданных.

Список доступных форматов метаданных можно получить с помощью метода getMetadataFormatNames.

Параметры:
formatName — требуемый формат метаданных.
Возвращает:
объект Node XML DOM, являющийся корнем дерева.
Исключения:
IllegalArgumentException — если formatName равно null или не является одним из имён, возвращаемых методом getMetadataFormatNames.
См. также:
  • getMetadataFormatNames()
  • setFromTree(String, Node)
  • mergeTree(String, Node)

mergeTree

public abstract void mergeTree(String formatName, Node root) throws IIOInvalidTreeException
Изменяет внутреннее состояние этого объекта IIOMetadata на основе дерева объектов Node XML DOM, синтаксис которых определён заданным форматом метаданных. Предыдущее состояние изменяется только в той мере, которая необходима для добавления узлов, присутствующих в заданном дереве. Если структура или содержимое дерева недопустимы, будет выброшено исключение IIOInvalidTreeException.

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

Параметры:
formatName — требуемый формат метаданных.
root — объект Node XML DOM, являющийся корнем дерева.
Исключения:
IllegalStateException — если этот объект доступен только для чтения.
IllegalArgumentException — если formatName равно null или не является одним из имён, возвращаемых методом getMetadataFormatNames.
IllegalArgumentException — если root равно null.
IIOInvalidTreeException — если дерево не удаётся успешно разобрать согласно правилам заданного формата.
См. также:
  • getMetadataFormatNames()
  • getAsTree(String)
  • setFromTree(String, Node)

getStandardChromaNode

protected IIOMetadataNode getStandardChromaNode()
Возвращает объект IIOMetadataNode, представляющий информацию о цветности стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна. Этот метод предназначен для вызова служебной процедурой getStandardTree.

Реализация по умолчанию возвращает null.

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

Возвращает:
объект IIOMetadataNode или null.
См. также:
  • getStandardTree()

getStandardCompressionNode

protected IIOMetadataNode getStandardCompressionNode()
Возвращает объект IIOMetadataNode, представляющий информацию о сжатии стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна. Этот метод предназначен для вызова служебной процедурой getStandardTree.

Реализация по умолчанию возвращает null.

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

Возвращает:
объект IIOMetadataNode или null.
См. также:
  • getStandardTree()

getStandardDataNode

protected IIOMetadataNode getStandardDataNode()
Возвращает объект IIOMetadataNode, представляющий информацию о формате данных стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна. Этот метод предназначен для вызова служебной процедурой getStandardTree.

Реализация по умолчанию возвращает null.

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

Возвращает:
объект IIOMetadataNode или null.
См. также:
  • getStandardTree()

getStandardDimensionNode

protected IIOMetadataNode getStandardDimensionNode()
Возвращает объект IIOMetadataNode, представляющий информацию о размерах стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна. Этот метод предназначен для вызова служебной процедурой getStandardTree.

Реализация по умолчанию возвращает null.

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

Возвращает:
объект IIOMetadataNode или null.
См. также:
  • getStandardTree()

getStandardDocumentNode

protected IIOMetadataNode getStandardDocumentNode()
Возвращает объект IIOMetadataNode, представляющий информацию о документе стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна. Этот метод предназначен для вызова служебной процедурой getStandardTree.

Реализация по умолчанию возвращает null.

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

Возвращает:
объект IIOMetadataNode или null.
См. также:
  • getStandardTree()

getStandardTextNode

protected IIOMetadataNode getStandardTextNode()
Возвращает объект IIOMetadataNode, представляющий текстовую информацию стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна. Этот метод предназначен для вызова служебной процедурой getStandardTree.

Реализация по умолчанию возвращает null.

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

Возвращает:
объект IIOMetadataNode или null.
См. также:
  • getStandardTree()

getStandardTileNode

protected IIOMetadataNode getStandardTileNode()
Возвращает объект IIOMetadataNode, представляющий информацию о разбиении на плитки стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна. Этот метод предназначен для вызова служебной процедурой getStandardTree.

Реализация по умолчанию возвращает null.

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

Возвращает:
объект IIOMetadataNode или null.
См. также:
  • getStandardTree()

getStandardTransparencyNode

protected IIOMetadataNode getStandardTransparencyNode()
Возвращает объект IIOMetadataNode, представляющий информацию о прозрачности стандартного формата метаданных javax_imageio_1.0, или null, если такая информация недоступна. Этот метод предназначен для вызова служебной процедурой getStandardTree.

Реализация по умолчанию возвращает null.

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

Возвращает:
объект IIOMetadataNode или null.

getStandardTree

protected final IIOMetadataNode getStandardTree()
Служебный метод для возврата дерева объектов IIOMetadataNode, представляющих метаданные, содержащиеся в этом объекте, согласно соглашениям стандартного формата метаданных javax_imageio_1.0.

Этот метод вызывает различные методы getStandard*Node для создания поддеревьев, корнями которых являются дочерние узлы корневого узла. Если любой из этих методов возвращает null, соответствующее поддерево не включается. Если все они возвращают null, возвращается дерево, состоящее из одного корневого узла.

Возвращает:
объект IIOMetadataNode, представляющий корень дерева метаданных в формате javax_imageio_1.0.
См. также:
  • getStandardChromaNode()
  • getStandardCompressionNode()
  • getStandardDataNode()
  • getStandardDimensionNode()
  • getStandardDocumentNode()
  • getStandardTextNode()
  • getStandardTileNode()
  • getStandardTransparencyNode()

setFromTree

public void setFromTree(String formatName, Node root) throws IIOInvalidTreeException
Устанавливает внутреннее состояние этого объекта IIOMetadata на основе дерева объектов Node XML DOM, синтаксис которых определён заданным форматом метаданных. Предыдущее состояние отбрасывается. Если структура или содержимое дерева недопустимы, будет выброшено исключение IIOInvalidTreeException.

Реализация по умолчанию вызывает reset, а затем mergeTree(formatName, root).

Параметры:
formatName — требуемый формат метаданных.
root — объект Node XML DOM, являющийся корнем дерева.
Исключения:
IllegalStateException — если этот объект доступен только для чтения.
IllegalArgumentException — если formatName равно null или не является одним из имён, возвращаемых методом getMetadataFormatNames.
IllegalArgumentException — если root равно null.
IIOInvalidTreeException — если дерево не удаётся успешно разобрать согласно правилам заданного формата.
См. также:
  • getMetadataFormatNames()
  • getAsTree(String)
  • mergeTree(String, Node)

reset

public abstract void reset()
Сбрасывает все данные, хранящиеся в этом объекте, к значениям по умолчанию; обычно объект возвращается в состояние, в котором он находился сразу после создания, хотя точная семантика зависит от подключаемого модуля. Обратите внимание, что существует множество возможных значений по умолчанию в зависимости от способа создания объекта.
Исключения:
IllegalStateException — если этот объект доступен только для чтения.
См. также:
  • ImageReader.getStreamMetadata()
  • ImageReader.getImageMetadata(int)
  • ImageWriter.getDefaultStreamMetadata(ImageWriteParam)
  • ImageWriter.getDefaultImageMetadata(ImageTypeSpecifier, ImageWriteParam)

setController

public void setController(IIOMetadataController controller)
Задаёт контроллер IIOMetadataController, который будет использоваться для предоставления настроек этого объекта IIOMetadata при вызове метода activateController, переопределяя любой контроллер по умолчанию. Если аргумент равен null, контроллер использоваться не будет, в том числе контроллер по умолчанию. Чтобы восстановить контроллер по умолчанию, используйте setController(getDefaultController()).

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

Параметры:
controller — подходящий объект IIOMetadataController или null.
См. также:
  • IIOMetadataController
  • getController()
  • getDefaultController()
  • hasController()
  • activateController()

getController

public IIOMetadataController getController()
Возвращает установленный в данный момент объект IIOMetadataController. Это может быть контроллер по умолчанию, если он есть, null или аргумент последнего вызова setController.

Реализация по умолчанию возвращает значение экземплярной переменной controller.

Возвращает:
установленный в данный момент объект IIOMetadataController или null.
См. также:
  • IIOMetadataController
  • setController(IIOMetadataController)
  • getDefaultController()
  • hasController()
  • activateController()

getDefaultController

public IIOMetadataController getDefaultController()
Возвращает контроллер IIOMetadataController по умолчанию, если он есть, независимо от установленного в данный момент контроллера. Если контроллера по умолчанию нет, возвращает null.

Реализация по умолчанию возвращает значение экземплярной переменной defaultController.

Возвращает:
контроллер IIOMetadataController по умолчанию или null.
См. также:
  • IIOMetadataController
  • setController(IIOMetadataController)
  • getController()
  • hasController()
  • activateController()

hasController

public boolean hasController()
Возвращает true, если для этого объекта IIOMetadata установлен контроллер.

Реализация по умолчанию возвращает true, если метод getController возвращает значение, отличное от null.

Возвращает:
true, если контроллер установлен.
См. также:
  • IIOMetadataController
  • setController(IIOMetadataController)
  • getController()
  • getDefaultController()
  • activateController()

activateController

public boolean activateController()
Активирует установленный IIOMetadataController для этого объекта IIOMetadata и возвращает полученное значение. Когда этот метод возвращает true, все значения для этого объекта IIOMetadata будут готовы к следующей операции записи. Если возвращается false, настройки этого объекта не будут изменены (т. е., пользователь отменил операцию).

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

Реализация по умолчанию вызывает getController и activate для возвращённого объекта, если hasController возвращает true.

Возвращает:
true, если контроллер завершил работу нормально.
Вызывает исключение:
IllegalStateException — если в данный момент контроллер не установлен.
См. также:
  • IIOMetadataController
  • setController(IIOMetadataController)
  • getController()
  • getDefaultController()
  • hasController()

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, которая содержит более подробные описания для разработчиков, включая концептуальные обзоры, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторское право © 1993, 2026, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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.

Spec-Zone.ru

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