Класс IIOMetadata

public abstract class IIOMetadata
extends Object

Абстрактный класс, который должен быть расширен объектами, представляющими метаданные (не относящиеся к изображению) изображения и потоков. Плагины представляют метаданные с помощью неявных, специфичных для плагина объектов. Однако эти объекты предоставляют возможность доступа к их внутренней информации в виде дерева IIOMetadataNode объектов, которые поддерживают интерфейсы XML DOM, а также дополнительные интерфейсы для хранения нетекстовых данных и получения информации о допустимых значениях данных. Формат таких деревьев зависит от плагина, но плагины могут выбрать поддержку нейтрального для плагина формата, описанного ниже. Один плагин может поддерживать несколько форматов метаданных, имена которых могут быть определены вызовом getMetadataFormatNames. Плагин также может поддерживать один специальный формат, называемый «родным» форматом, который предназначен для кодирования метаданных без потерь. Этот формат обычно разрабатывается специально для работы со специфическим форматом файла, так что изображения можно загружать и сохранять в том же формате без потери метаданных, но он может быть менее полезен для передачи метаданных между ImageReader и ImageWriter для различных форматов изображений. Для преобразования между двумя родными форматами без потерь, насколько это позволяет формат файла изображения, необходимо использовать объект ImageTranscoder.

См. также:
ImageReader.getImageMetadata(int), ImageReader.getStreamMetadata(), ImageReader.readAll(int, javax.imageio.ImageReadParam), ImageWriter.getDefaultStreamMetadata(javax.imageio.ImageWriteParam), ImageWriter.getDefaultImageMetadata(javax.imageio.ImageTypeSpecifier, javax.imageio.ImageWriteParam), ImageWriter.write(javax.imageio.metadata.IIOMetadata, javax.imageio.IIOImage, javax.imageio.ImageWriteParam), ImageTranscoder.convertImageMetadata(javax.imageio.metadata.IIOMetadata, javax.imageio.ImageTypeSpecifier, javax.imageio.ImageWriteParam), ImageTranscoder.convertStreamMetadata(javax.imageio.metadata.IIOMetadata, javax.imageio.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

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

Сводка конструкторов

Модификатор Конструктор Описание
protected IIOMetadata()

Создаёт пустой объект IIOMetadata.

protected IIOMetadata​(boolean standardMetadataFormatSupported, String nativeMetadataFormatName, String nativeMetadataFormatClassName, String[] extraMetadataFormatNames, String[] extraMetadataFormatClassNames)

Создаёт объект IIOMetadata с заданными именами форматов и именами классов форматов, а также булевым значением, указывающим, поддерживается ли стандартный формат.

Методы

Модификатор и тип Метод Описание
boolean activateController()

Активирует установленный IIOMetadataController для этого объекта IIOMetadata и возвращает результат.
abstract Node getAsTree​(String formatName)

Возвращает объект XML DOM Node , представляющий корень дерева метаданных, содержащихся в этом объекте в соответствии с соглашениями, определенными заданным форматом метаданных.
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 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 с дерева XML DOM Node , синтаксис которого определен заданным форматом метаданных.
abstract void reset()

Сбрасывает все данные, хранящиеся в этом объекте, на значения по умолчанию, обычно в состояние, в котором этот объект находился сразу после создания, хотя точный смысл зависит от плагина.
void setController​(IIOMetadataController controller)

Устанавливает IIOMetadataController для предоставления настроек для этого объекта IIOMetadata при вызове метода activateController, переопределяя любой контроллер по умолчанию.
void setFromTree​(String formatName, Node root)

Устанавливает внутреннее состояние этого объекта IIOMetadata с дерева XML DOM Node , синтаксис которого определен заданным форматом метаданных.

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

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

Поля

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(java.lang.String), setFromTree(java.lang.String, org.w3c.dom.Node), mergeTree(java.lang.String, org.w3c.dom.Node), getMetadataFormat(java.lang.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(java.lang.String), setFromTree(java.lang.String, org.w3c.dom.Node), mergeTree(java.lang.String, org.w3c.dom.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)

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

Имена доступных форматов метаданных могут быть запрошены с помощью метода getMetadataFormatNames.

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

mergeTree

public abstract void mergeTree(String formatName,
                               Node root)
                        throws IIOInvalidTreeException

Изменяет внутреннее состояние этого объекта IIOMetadata из дерева XML DOM Node чья синтаксис определяется заданным форматом метаданных. Предыдущее состояние изменяется только по необходимости, чтобы вместить узлы, присутствующие в заданном дереве. Если структура или содержимое дерева некорректны, будет выброшено исключение IIOInvalidTreeException.

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

Параметры:
formatName - желаемый формат метаданных.
root - объект XML DOM Node образующий корень дерева.
Исключения:
IllegalStateException - если этот объект является только для чтения.
IllegalArgumentException - если formatName является null или не является одним из имён, возвращаемых getMetadataFormatNames.
IllegalArgumentException - если root является null.
IIOInvalidTreeException - если дерево не может быть успешно обработано по правилам заданного формата.
См. также:
getMetadataFormatNames(), getAsTree(java.lang.String), setFromTree(java.lang.String, org.w3c.dom.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.

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

Returns:
an IIOMetadataNode, or null.
See Also:
getStandardTree()

getStandardTextNode

protected IIOMetadataNode getStandardTextNode()

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

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

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

Returns:
an IIOMetadataNode, or null.
See Also:
getStandardTree()

getStandardTileNode

protected IIOMetadataNode getStandardTileNode()

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

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

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

Returns:
an IIOMetadataNode, or null.
See Also:
getStandardTree()

getStandardTransparencyNode

protected IIOMetadataNode getStandardTransparencyNode()

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

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

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

Returns:
an IIOMetadataNode, or null.

getStandardTree

protected final IIOMetadataNode getStandardTree()

Вспомогательный метод для возврата дерева IIOMetadataNode представляющих метаданные, содержащиеся в этом объекте, в соответствии с соглашениями стандартного javax_imageio_1.0 формата метаданных.

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

Returns:
an IIOMetadataNode representing the root of a metadata tree in the javax_imageio_1.0 format.
See Also:
getStandardChromaNode(), getStandardCompressionNode(), getStandardDataNode(), getStandardDimensionNode(), getStandardDocumentNode(), getStandardTextNode(), getStandardTileNode(), getStandardTransparencyNode()

setFromTree

public void setFromTree(String formatName,
                        Node root)
                 throws IIOInvalidTreeException

Устанавливает внутреннее состояние этого объекта IIOMetadata из дерева XML DOM Node, синтаксис которого определен заданным форматом метаданных. Предыдущее состояние отбрасывается. Если структура или содержимое дерева неверны, будет выброшено исключение IIOInvalidTreeException.

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

Parameters:
formatName - the desired metadata format.
root - an XML DOM Node object forming the root of a tree.
Throws:
IllegalStateException - if this object is read-only.
IllegalArgumentException - if formatName is null or is not one of the names returned by getMetadataFormatNames.
IllegalArgumentException - if root is null.
IIOInvalidTreeException - if the tree cannot be parsed successfully using the rules of the given format.
See Also:
getMetadataFormatNames(), getAsTree(java.lang.String), mergeTree(java.lang.String, org.w3c.dom.Node)

reset

public abstract void reset()

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

Throws:
IllegalStateException - if this object is read-only.
See Also:
ImageReader.getStreamMetadata(), ImageReader.getImageMetadata(int), ImageWriter.getDefaultStreamMetadata(javax.imageio.ImageWriteParam), ImageWriter.getDefaultImageMetadata(javax.imageio.ImageTypeSpecifier, javax.imageio.ImageWriteParam)

setController

public void setController(IIOMetadataController controller)

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

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

Parameters:
controller - An appropriate IIOMetadataController, or null.
See Also:
IIOMetadataController, getController(), getDefaultController(), hasController(), activateController()

getController

public IIOMetadataController getController()

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

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

Returns:
the currently installed IIOMetadataController, or null.
See Also:
IIOMetadataController, setController(javax.imageio.metadata.IIOMetadataController), getDefaultController(), hasController(), activateController()

getDefaultController

public IIOMetadataController getDefaultController()

Возвращает контроллер по умолчанию IIOMetadataController, если он есть, независимо от текущего установленного контроллера. Если контроллера по умолчанию нет, возвращает null.

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

Returns:
the default IIOMetadataController, or null.
See Also:
IIOMetadataController, setController(IIOMetadataController), getController(), hasController(), activateController()

hasController

public boolean hasController()

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

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

Returns:
true if a controller is installed.
See Also:
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()

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/IIOMetadata.html

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