Интерфейс IIOMetadataFormat

Все известные реализующие классы:: IIOMetadataFormatImpl

public interface IIOMetadataFormat

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

Примечание: классы, реализующие этот интерфейс, должны содержать метод, объявленный как public static getInstance() , который возвращает экземпляр класса. Обычно реализация создает только один экземпляр и кеширует его для будущих вызовов getInstance.

В случае, если плагин предоставляется в составе именованного модуля, этот модуль должен экспортировать пакет, содержащий реализующий класс, в

java.desktop

модуль посредством квалифицированного экспорта. Неквалифицированный экспорт не рекомендуется, если он не нужен также по какой-либо другой причине. Отсутствие экспорта пакета приведет к ошибке доступа во время выполнения.

Структуры, которые могут быть описаны этим классом, являются подмножеством тех, которые могут быть выражены с помощью определений типа документа XML (DTD), с добавлением некоторых основных сведений о типах данных атрибутов и возможностью хранить Object ссылку внутри узла. В будущем для представления этих структур могут использоваться XML-схемы и многие другие.

Различия между структурами, описанными IIOMetadataFormat , и DTD заключаются в следующем:

Элементы не могут содержать текст или смешивать текст со вложенными тегами.
Дочерние элементы элемента должны соответствовать одному из нескольких простых шаблонов, описанных в документации для CHILD_* констант;
Внутреннее представление элементов может содержать ссылку на Object. Нет возможности представлять такие объекты в текстовом формате.

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

Модификатор и тип	Поле	Описание
`static final int`	`CHILD_POLICY_ALL`	Константа, возвращаемая `getChildPolicy` для обозначения того, что элемент должен иметь по одному экземпляру каждого из его допустимых дочерних элементов в порядке.
`static final int`	`CHILD_POLICY_CHOICE`	Константа, возвращаемая `getChildPolicy` для обозначения того, что элемент должен иметь ноль или один дочерний элемент, выбранный из числа его допустимых дочерних элементов.
`static final int`	`CHILD_POLICY_EMPTY`	Константа, возвращаемая `getChildPolicy` для обозначения того, что элемент не может иметь дочерних элементов.
`static final int`	`CHILD_POLICY_MAX`	Наибольшая допустимая `CHILD_POLICY_*` константа, используемая для проверок диапазона.
`static final int`	`CHILD_POLICY_REPEAT`	Константа, возвращаемая `getChildPolicy` для обозначения того, что элемент должен иметь ноль или более экземпляров своего уникального допустимого дочернего элемента.
`static final int`	`CHILD_POLICY_SEQUENCE`	Константа, возвращаемая `getChildPolicy` для обозначения того, что элемент должен иметь последовательность экземпляров любого из его допустимых дочерних элементов.
`static final int`	`CHILD_POLICY_SOME`	Константа, возвращаемая `getChildPolicy` для обозначения того, что элемент должен иметь ноль или один экземпляр каждого из своих допустимых дочерних элементов в порядке.
`static final int`	`DATATYPE_BOOLEAN`	Константа, возвращаемая `getAttributeDataType` , указывающая, что значение атрибута является одним из значений boolean 'true' или 'false'.
`static final int`	`DATATYPE_DOUBLE`	Константа, возвращаемая `getAttributeDataType` , указывающая, что значение атрибута является строковым представлением числа с плавающей запятой двойной точности.
`static final int`	`DATATYPE_FLOAT`	Константа, возвращаемая `getAttributeDataType` , указывающая, что значение атрибута является строковым представлением десятичного числа с плавающей запятой.
`static final int`	`DATATYPE_INTEGER`	Константа, возвращаемая `getAttributeDataType` , указывающая, что значение атрибута является строковым представлением целого числа.
`static final int`	`DATATYPE_STRING`	Константа, возвращаемая `getAttributeDataType` , указывающая, что значение атрибута является общей строкой Unicode.
`static final int`	`VALUE_ARBITRARY`	Константа, возвращаемая `getAttributeValueType` и `getObjectValueType` , указывающая, что атрибут или пользовательский объект могут быть установлены в одно произвольное значение.
`static final int`	`VALUE_ENUMERATION`	Константа, возвращаемая `getAttributeValueType` и `getObjectValueType` , указывающая, что атрибут или пользовательский объект могут быть установлены в одно из перечисленных значений.
`static final int`	`VALUE_LIST`	Константа, возвращаемая `getAttributeValueType` и `getObjectValueType` , указывающая, что атрибут или пользовательский объект могут быть установлены в список или массив значений.
`static final int`	`VALUE_NONE`	Константа, возвращаемая `getObjectValueType` , указывающая отсутствие пользовательского объекта.
`static final int`	`VALUE_RANGE`	Константа, возвращаемая `getAttributeValueType` и `getObjectValueType` , указывающая, что атрибут или пользовательский объект могут быть установлены в диапазон значений.
`static final int`	`VALUE_RANGE_MAX_INCLUSIVE`	Константа, возвращаемая `getAttributeValueType` и `getObjectValueType` , указывающая, что атрибут или пользовательский объект могут быть установлены в диапазон значений.
`static final int`	`VALUE_RANGE_MAX_INCLUSIVE_MASK`	Значение, которое можно побитово сложить с `VALUE_RANGE` для получения `VALUE_RANGE_MAX_INCLUSIVE`, и с `VALUE_RANGE_MIN_INCLUSIVE` для получения `VALUE_RANGE_MIN_MAX_INCLUSIVE`.
`static final int`	`VALUE_RANGE_MIN_INCLUSIVE`	Константа, возвращаемая `getAttributeValueType` и `getObjectValueType` , указывающая, что атрибут или пользовательский объект могут быть установлены в диапазон значений.
`static final int`	`VALUE_RANGE_MIN_INCLUSIVE_MASK`	Значение, которое можно побитово сложить с `VALUE_RANGE` для получения `VALUE_RANGE_MIN_INCLUSIVE`, и с `VALUE_RANGE_MAX_INCLUSIVE` для получения `VALUE_RANGE_MIN_MAX_INCLUSIVE`.
`static final int`	`VALUE_RANGE_MIN_MAX_INCLUSIVE`	Константа, возвращаемая `getAttributeValueType` и `getObjectValueType` , указывающая, что атрибут или пользовательский объект могут быть установлены в диапазон значений.

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

Модификатор и тип	Метод	Описание
`boolean`	`canNodeAppear(String elementName, ImageTypeSpecifier imageType)`	Возвращает `true`, если элемент (и поддерево ниже него) разрешено отображать в документе метаданных для изображения заданного типа, определённого `ImageTypeSpecifier`.
`int`	`getAttributeDataType(String elementName, String attrName)`	Возвращает одну из констант, начинающихся с `DATATYPE_`, указывающую формат и интерпретацию значения данного атрибута в указанном элементе.
`String`	`getAttributeDefaultValue(String elementName, String attrName)`	Возвращает значение по умолчанию указанного атрибута, если он не явно указан в указанном элементе, в виде `String`, или `null`, если значение по умолчанию недоступно.
`String`	`getAttributeDescription(String elementName, String attrName, Locale locale)`	Возвращает `String` с описанием указанного атрибута, или `null`.
`String[]`	`getAttributeEnumerations(String elementName, String attrName)`	Возвращает массив `String` с перечислением допустимых значений для данного атрибута в указанном элементе.
`int`	`getAttributeListMaxLength(String elementName, String attrName)`	Возвращает максимальное количество элементов списка, которое может быть использовано для определения данного атрибута.
`int`	`getAttributeListMinLength(String elementName, String attrName)`	Возвращает минимальное количество элементов списка, которое может быть использовано для определения данного атрибута.
`String`	`getAttributeMaxValue(String elementName, String attrName)`	Возвращает максимальное допустимое значение для атрибута.
`String`	`getAttributeMinValue(String elementName, String attrName)`	Возвращает минимальное допустимое значение для атрибута.
`String[]`	`getAttributeNames(String elementName)`	Возвращает массив `String` с перечислением имён атрибутов, которые могут быть связаны с указанным элементом.
`int`	`getAttributeValueType(String elementName, String attrName)`	Возвращает одну из констант, начинающихся с `VALUE_`, указывающую, являются ли значения данного атрибута произвольными, ограниченными заданным диапазоном, ограниченными набором перечисленных значений или представляют собой список произвольных значений, разделённых пробелами.
`String[]`	`getChildNames(String elementName)`	Возвращает массив `String` с именами элементов, которые могут быть дочерними для указанного элемента, в порядке их появления.
`int`	`getChildPolicy(String elementName)`	Возвращает одну из констант, начинающихся с `CHILD_POLICY_`, указывающую допустимую структуру дочерних элементов для указанного элемента.
`String`	`getElementDescription(String elementName, Locale locale)`	Возвращает `String` с описанием указанного элемента, или `null`.
`int`	`getElementMaxChildren(String elementName)`	Возвращает максимальное количество дочерних элементов указанного элемента с политикой дочерних элементов `CHILD_POLICY_REPEAT`.
`int`	`getElementMinChildren(String elementName)`	Возвращает минимальное количество дочерних элементов указанного элемента с политикой дочерних элементов `CHILD_POLICY_REPEAT`.
`int`	`getObjectArrayMaxLength(String elementName)`	Возвращает максимальное количество элементов массива, которые могут быть использованы для определения `Object` ссылки в указанном элементе.
`int`	`getObjectArrayMinLength(String elementName)`	Возвращает минимальное количество элементов массива, которые могут быть использованы для определения `Object` ссылки в указанном элементе.
`Class<?>`	`getObjectClass(String elementName)`	Возвращает тип `Class` `Object` ссылки, хранящейся в элементе.
`Object`	`getObjectDefaultValue(String elementName)`	Возвращает `Object` с значением по умолчанию для `Object` ссылки в указанном элементе.
`Object[]`	`getObjectEnumerations(String elementName)`	Возвращает массив `Object` с допустимыми перечисленными значениями для `Object` ссылки в указанном элементе.
`Comparable<?>`	`getObjectMaxValue(String elementName)`	Возвращает максимальное допустимое значение для `Object` ссылки в указанном элементе.
`Comparable<?>`	`getObjectMinValue(String elementName)`	Возвращает минимальное допустимое значение для `Object` ссылки в указанном элементе.
`int`	`getObjectValueType(String elementName)`	Возвращает одно из перечисленных значений, начинающихся с `VALUE_`, указывающее тип разрешённых значений (перечисление, диапазон или массив) для `Object` ссылки.
`String`	`getRootName()`	Возвращает имя корневого элемента формата.
`boolean`	`isAttributeRequired(String elementName, String attrName)`	Возвращает `true`, если указанный атрибут должен присутствовать в указанном элементе.

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

CHILD_POLICY_EMPTY

static final int CHILD_POLICY_EMPTY

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

См. также:

Значения постоянных полей

CHILD_POLICY_ALL

static final int CHILD_POLICY_ALL

Постоянная, возвращаемая getChildPolicy, чтобы указать, что элемент должен иметь по одному экземпляру каждого своего допустимого дочернего элемента в определенном порядке. В терминах DTD содержимое элемента определяется последовательностью a,b,c,d,....

См. также:

Значения постоянных полей

CHILD_POLICY_SOME

static final int CHILD_POLICY_SOME

Постоянная, возвращаемая getChildPolicy, чтобы указать, что элемент должен иметь ноль или один экземпляр каждого своего допустимого дочернего элемента в определенном порядке. В терминах DTD содержимое элемента определяется последовательностью a,b,c,d,....

См. также:

Значения постоянных полей

CHILD_POLICY_CHOICE

static final int CHILD_POLICY_CHOICE

Постоянная, возвращаемая getChildPolicy, чтобы указать, что элемент должен иметь ноль или один дочерний элемент, выбранный из его допустимых дочерних элементов. В терминах DTD содержимое элемента определяется выбором a|b|c|d|....

См. также:

Значения постоянных полей

CHILD_POLICY_SEQUENCE

static final int CHILD_POLICY_SEQUENCE

Постоянная, возвращаемая getChildPolicy, чтобы указать, что элемент должен иметь последовательность экземпляров любых его допустимых дочерних элементов. В терминах DTD содержимое элемента определяется последовательностью (a|b|c|d|...)*.

См. также:

Значения постоянных полей

CHILD_POLICY_REPEAT

static final int CHILD_POLICY_REPEAT

Постоянная, возвращаемая getChildPolicy, чтобы указать, что элемент должен иметь ноль или более экземпляров своего уникального допустимого дочернего элемента. В терминах DTD содержимое элемента определяется выражением со звездочкой a*.

См. также:

Значения постоянных полей

CHILD_POLICY_MAX

static final int CHILD_POLICY_MAX

Наибольшая допустимая CHILD_POLICY_* константа, используемая для проверок диапазона.

См. также:

Значения постоянных полей

VALUE_NONE

static final int VALUE_NONE

Постоянная, возвращаемая getObjectValueType, чтобы указать отсутствие пользовательского объекта.

См. также:

Значения постоянных полей

VALUE_ARBITRARY

static final int VALUE_ARBITRARY

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

См. также:

Значения постоянных полей

VALUE_RANGE

static final int VALUE_RANGE

Постоянная, возвращаемая getAttributeValueType и getObjectValueType, чтобы указать, что атрибут или пользовательский объект может быть установлен в диапазон значений. Минимальное и максимальное значения диапазона исключаются. Рекомендуется, чтобы диапазоны целых чисел были включительными с обеих сторон, и чтобы исключительные диапазоны использовались только для данных с плавающей точкой.

См. также:

VALUE_RANGE_MIN_INCLUSIVE_MASK

static final int VALUE_RANGE_MIN_INCLUSIVE_MASK

Значение, которое может быть сложено с VALUE_RANGE для получения VALUE_RANGE_MIN_INCLUSIVE, и с VALUE_RANGE_MAX_INCLUSIVE для получения VALUE_RANGE_MIN_MAX_INCLUSIVE.

Аналогично, значение может быть перемножено со значением getAttributeValueType или getObjectValueType, чтобы определить, является ли минимальное значение диапазона включительно.

См. также:

Значения постоянных полей

VALUE_RANGE_MAX_INCLUSIVE_MASK

static final int VALUE_RANGE_MAX_INCLUSIVE_MASK

Значение, которое может быть сложено с VALUE_RANGE для получения VALUE_RANGE_MAX_INCLUSIVE, и с VALUE_RANGE_MIN_INCLUSIVE для получения VALUE_RANGE_MIN_MAX_INCLUSIVE.

Аналогично, значение может быть перемножено со значением getAttributeValueType или getObjectValueType, чтобы определить, является ли максимальное значение диапазона включительно.

См. также:

Значения постоянных полей

VALUE_RANGE_MIN_INCLUSIVE

static final int VALUE_RANGE_MIN_INCLUSIVE

См. также:

Значения постоянных полей

VALUE_RANGE_MAX_INCLUSIVE

static final int VALUE_RANGE_MAX_INCLUSIVE

См. также:

Значения постоянных полей

VALUE_RANGE_MIN_MAX_INCLUSIVE

static final int VALUE_RANGE_MIN_MAX_INCLUSIVE

Постоянная, возвращаемая getAttributeValueType и getObjectValueType, чтобы указать, что атрибут или пользовательский объект может быть установлен в диапазон значений. И минимальное, и максимальное значения диапазона включительно. Рекомендуется, чтобы диапазоны целых чисел были включительными с обеих сторон, и чтобы исключительные диапазоны использовались только для данных с плавающей точкой.

См. также:

Значения постоянных полей

VALUE_ENUMERATION

static final int VALUE_ENUMERATION

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

Значения атрибутов типа DATATYPE_BOOLEAN должны быть помечены как перечисления.

См. также:

Значения постоянных полей

VALUE_LIST

static final int VALUE_LIST

Постоянная, возвращаемая getAttributeValueType и getObjectValueType, чтобы указать, что атрибут или пользовательский объект может быть установлен в список или массив значений. В случае атрибутов список будет содержать значения, разделенные пробелами, внутри String; для объектов будет использован массив.

См. также:

Значения постоянных полей

DATATYPE_STRING

static final int DATATYPE_STRING

Постоянная, возвращаемая getAttributeDataType, указывающая, что значение атрибута является строкой Юникода общего вида.

См. также:

Значения постоянных полей

DATATYPE_BOOLEAN

static final int DATATYPE_BOOLEAN

Постоянная, возвращаемая getAttributeDataType, указывающая, что значение атрибута является одним из логических значений 'true' или 'false'. Значения атрибутов типа DATATYPE_BOOLEAN должны быть помечены как перечисления, и допустимые значения должны быть строковыми литералами "TRUE" или "FALSE", хотя плагин может также распознавать эквиваленты в нижнем или смешанном регистре.

См. также:

Значения постоянных полей

DATATYPE_INTEGER

static final int DATATYPE_INTEGER

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

См. также:

Значения постоянных полей

DATATYPE_FLOAT

static final int DATATYPE_FLOAT

Постоянная, возвращаемая getAttributeDataType, указывающая, что значение атрибута является строковым представлением десятичного числа с плавающей точкой.

См. также:

Значения постоянных полей

DATATYPE_DOUBLE

static final int DATATYPE_DOUBLE

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

См. также:

Значения постоянных полей

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

getRootName

String getRootName()

Возвращает имя корневого элемента формата.

Возвращает:: a String.

canNodeAppear

boolean canNodeAppear(String elementName, ImageTypeSpecifier imageType)

Возвращает true, если элемент (и поддерево ниже него) разрешено отображать в документе метаданных для изображения данного типа, определенного ImageTypeSpecifier. Например, формат документа метаданных может содержать элемент, описывающий основные цвета изображения, что не допускается при записи изображения в оттенках серого.

Параметры:: elementName - имя запрошенного элемента.; imageType - ImageTypeSpecifier, указывающий тип изображения, которое будет связано с метаданными.
Возвращает:: true, если узел имеет значение для изображений данного типа.

getElementMinChildren

int getElementMinChildren(String elementName)

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

Параметры:: elementName - имя запрошенного элемента.
Возвращает:: an int.
Исключения:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для этого формата.; IllegalArgumentException - если у указанного элемента нет политики дочерних элементов CHILD_POLICY_REPEAT.

getElementMaxChildren

int getElementMaxChildren(String elementName)

Возвращает максимальное количество дочерних элементов указанного элемента с политикой дочерних элементов CHILD_POLICY_REPEAT. Например, элемент, представляющий запись в палитре 8-битного цвета, может повторяться до 256 раз. Значение Integer.MAX_VALUE может использоваться для указания отсутствия верхнего предела.

Параметры:: elementName - имя запрошенного элемента.
Возвращает:: an int.
Исключения:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для этого формата.; IllegalArgumentException - если у указанного элемента нет политики дочерних элементов CHILD_POLICY_REPEAT.

getElementDescription

String getElementDescription(String elementName, Locale locale)

Возвращает String, содержащий описание указанного элемента, или null. Описание будет локализовано для предоставленного Locale, если это возможно.

Если locale имеет значение null, будет использоваться текущая локаль Locale, возвращаемая Locale.getLocale.

Параметры:: elementName - имя элемента.; locale - Locale для которого будет выполняться локализация.
Возвращает:: описание элемента.
Исключения:: IllegalArgumentException - если elementName имеет значение null, или не является допустимым именем элемента для этого формата.

getChildPolicy

int getChildPolicy(String elementName)

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

Параметры:: elementName - имя запрошенного элемента.
Возвращает:: одну из постоянных CHILD_POLICY_*.
Исключения:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для этого формата.

getChildNames

String[] getChildNames(String elementName)

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

Параметры:: elementName - имя запрошенного элемента.
Возвращает:: массив имен String, или null.
Исключения:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для этого формата.

getAttributeNames

String[] getAttributeNames(String elementName)

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

Параметры:: elementName - имя запрошенного элемента.
Возвращает:: массив имен String.
Исключения:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для этого формата.

getAttributeValueType

int getAttributeValueType(String elementName, String attrName)

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

Параметры:: elementName - имя запрошенного элемента.; attrName - имя запрошенного атрибута.
Возвращает:: одну из постоянных VALUE_*.
Исключения:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для этого формата.; IllegalArgumentException - если attrName имеет значение null или не является допустимым именем атрибута для этого элемента.

getAttributeDataType

int getAttributeDataType(String elementName, String attrName)

Возвращает одну из постоянных, начинающихся с DATATYPE_, указывающую формат и интерпретацию значения заданного атрибута в указанном элементе. Если getAttributeValueType возвращает VALUE_LIST, то допустимое значение является списком значений возвращаемого типа, разделенных пробелами.

Параметры:: elementName - имя запрошенного элемента.; attrName - имя запрошенного атрибута.
Возвращает:: одну из постоянных DATATYPE_*.
Исключения:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для этого формата.; IllegalArgumentException - если attrName имеет значение null или не является допустимым именем атрибута для этого элемента.

isAttributeRequired

boolean isAttributeRequired(String elementName, String attrName)

Возвращает true, если указанный атрибут должен быть присутствовать в указанном элементе.

Параметры:: elementName - имя запрошенного элемента.; attrName - имя запрошенного атрибута.
Возвращает:: true если атрибут должен быть присутствовать.
Исключения:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для этого формата.; IllegalArgumentException - если attrName имеет значение null или не является допустимым именем атрибута для этого элемента.

getAttributeDefaultValue

String getAttributeDefaultValue(String elementName, String attrName)

Возвращает значение по умолчанию указанного атрибута, если оно не задано явно в указанном элементе, в виде String, или null если значение по умолчанию недоступно.

Parameters:: elementName - имя запрашиваемого элемента.; attrName - имя запрашиваемого атрибута.
Returns:: a String содержащий значение по умолчанию, или null.
Throws:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для данного формата.; IllegalArgumentException - если attrName имеет значение null или не является допустимым именем атрибута для данного элемента.

getAttributeEnumerations

String[] getAttributeEnumerations(String elementName, String attrName)

Возвращает массив String содержащий допустимые перечисленные значения для данного атрибута в указанном элементе. Данный метод следует вызывать только если getAttributeValueType возвращает VALUE_ENUMERATION.

Parameters:: elementName - имя запрашиваемого элемента.; attrName - имя запрашиваемого атрибута.
Returns:: массив String.
Throws:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для данного формата.; IllegalArgumentException - если attrName имеет значение null или не является допустимым именем атрибута для данного элемента.; IllegalArgumentException - если данный атрибут не определён как перечисление.

getAttributeMinValue

String getAttributeMinValue(String elementName, String attrName)

Возвращает минимальное допустимое значение для атрибута. Включительно или исключающее значение определяется значением getAttributeValueType. Значение возвращается как String; его интерпретация зависит от значения getAttributeDataType. Данный метод следует вызывать только если getAttributeValueType возвращает VALUE_RANGE_*.

Parameters:: elementName - имя запрашиваемого элемента.; attrName - имя запрашиваемого атрибута.
Returns:: a String содержащий наименьшее допустимое значение для атрибута.
Throws:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для данного формата.; IllegalArgumentException - если attrName имеет значение null или не является допустимым именем атрибута для данного элемента.; IllegalArgumentException - если данный атрибут не определен как диапазон.

getAttributeMaxValue

String getAttributeMaxValue(String elementName, String attrName)

Возвращает максимальное допустимое значение для атрибута. Включительно или исключающее значение определяется значением getAttributeValueType. Значение возвращается как String; его интерпретация зависит от значения getAttributeDataType. Данный метод следует вызывать только если getAttributeValueType возвращает VALUE_RANGE_*.

Parameters:: elementName - имя запрашиваемого элемента, как String.; attrName - имя запрашиваемого атрибута.
Returns:: a String содержащий наибольшее допустимое значение для атрибута.
Throws:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для данного формата.; IllegalArgumentException - если attrName имеет значение null или не является допустимым именем атрибута для данного элемента.; IllegalArgumentException - если данный атрибут не определен как диапазон.

getAttributeListMinLength

int getAttributeListMinLength(String elementName, String attrName)

Возвращает минимальное количество элементов списка, которые могут быть использованы для определения данного атрибута. Сам атрибут определен как String содержащий несколько разделенных пробелами элементов. Данный метод следует вызывать только если getAttributeValueType возвращает VALUE_LIST.

Parameters:: elementName - имя запрашиваемого элемента.; attrName - имя запрашиваемого атрибута.
Returns:: наименьшее допустимое количество элементов списка для атрибута.
Throws:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для данного формата.; IllegalArgumentException - если attrName имеет значение null или не является допустимым именем атрибута для данного элемента.; IllegalArgumentException - если данный атрибут не определен как список.

getAttributeListMaxLength

int getAttributeListMaxLength(String elementName, String attrName)

Возвращает максимальное количество элементов списка, которые могут быть использованы для определения данного атрибута. Значение Integer.MAX_VALUE может быть использовано для указания отсутствия верхнего предела. Сам атрибут определен как String содержащий несколько разделенных пробелами элементов. Данный метод следует вызывать только если getAttributeValueType возвращает VALUE_LIST.

Parameters:: elementName - имя запрашиваемого элемента.; attrName - имя запрашиваемого атрибута.
Returns:: наибольшее допустимое количество элементов списка для атрибута.
Throws:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для данного формата.; IllegalArgumentException - если attrName имеет значение null или не является допустимым именем атрибута для данного элемента.; IllegalArgumentException - если данный атрибут не определен как список.

getAttributeDescription

String getAttributeDescription(String elementName, String attrName, Locale locale)

Возвращает String содержащий описание указанного атрибута, или null. Описание будет локализовано для предоставленного Locale если это возможно.

Если locale имеет значение null, будет использовано текущее значение по умолчанию Locale возвращаемое Locale.getLocale.

Parameters:: elementName - имя элемента.; attrName - имя атрибута.; locale - Locale для которого будет предпринята попытка локализации.
Returns:: описание атрибута.
Throws:: IllegalArgumentException - если elementName имеет значение null, или не является допустимым именем элемента для данного формата.; IllegalArgumentException - если attrName имеет значение null или не является допустимым именем атрибута для данного элемента.

getObjectValueType

int getObjectValueType(String elementName)

Возвращает одно из перечисленных значений, начинающихся с VALUE_, указывающее тип значений (перечисление, диапазон или массив), которые разрешены для ссылки Object. Если внутри данного элемента нельзя хранить значение объекта, результат этого метода будет VALUE_NONE.

Ссылки Object, чьи допустимые значения определены как диапазон, должны реализовывать интерфейс Comparable.

Parameters:

elementName - имя запрашиваемого элемента.

Returns:

одно из VALUE_* констант.

Throws:

IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для данного формата.

See Also:

Comparable

getObjectClass

Class<?> getObjectClass(String elementName)

Возвращает тип Class ссылки Object хранящейся в элементе. Если этот элемент не может содержать ссылку на Object, будет выброшено исключение IllegalArgumentException. Если тип класса является массивом, этот параметр указывает базовый тип класса (например, для массива int этот метод вернёт int.class).

Ссылки Object, чьи допустимые значения определены как диапазон, должны реализовывать интерфейс Comparable.

Parameters:: elementName - имя запрашиваемого элемента.
Returns:: объект Class.
Throws:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для данного формата.; IllegalArgumentException - если указанный элемент не может содержать значение объекта (т.е., если getObjectValueType(elementName) == VALUE_NONE).

getObjectDefaultValue

Object getObjectDefaultValue(String elementName)

Возвращает Object содержащий значение по умолчанию для ссылки Object в указанном элементе.

Parameters:: elementName - имя запрашиваемого элемента.
Returns:: a Object.
Throws:: IllegalArgumentException - если elementName имеет значение null или не является допустимым именем элемента для данного формата.; IllegalArgumentException - если указанный элемент не может содержать значение объекта (т.е., если getObjectValueType(elementName) == VALUE_NONE).

Получение перечислений объектов

Object[] getObjectEnumerations(String elementName)

Возвращает массив Object содержащих допустимые перечисленные значения для Object ссылки в заданном элементе. Этот метод следует вызывать только в том случае, если getObjectValueType возвращает VALUE_ENUMERATION.

Object связанного с узлом, принимающим перечисленные значения, должно быть равно одному из значений, возвращаемых этим методом, как определено оператором == (в отличие от метода Object.equals).

Параметры:: elementName - имя запрашиваемого элемента.
Возвращает:: массив Object.
Исключения:: IllegalArgumentException - если elementName является null или не является допустимым именем элемента для этого формата.; IllegalArgumentException - если указанный элемент не может содержать значение объекта (т.е., если getObjectValueType(elementName) == VALUE_NONE).; IllegalArgumentException - если Object не определен как перечисление.

Получение минимального значения объекта

Comparable<?> getObjectMinValue(String elementName)

Возвращает минимальное допустимое значение для Object ссылки в указанном элементе. Включительно или исключающее это значение может быть определено значением getObjectValueType. Этот метод следует вызывать только в том случае, если getObjectValueType возвращает одну из констант, начинающихся с VALUE_RANGE.

Параметры:: elementName - имя запрашиваемого элемента.
Возвращает:: наименьшее допустимое значение для атрибута.
Исключения:: IllegalArgumentException - если elementName является null или не является допустимым именем элемента для этого формата.; IllegalArgumentException - если указанный элемент не может содержать значение объекта (т.е., если getObjectValueType(elementName) == VALUE_NONE).; IllegalArgumentException - если Object не определен как диапазон.

Получение максимального значения объекта

Comparable<?> getObjectMaxValue(String elementName)

Возвращает максимальное допустимое значение для Object ссылки в указанном элементе. Включительно или исключающее это значение может быть определено значением getObjectValueType. Этот метод следует вызывать только в том случае, если getObjectValueType возвращает одну из констант, начинающихся с VALUE_RANGE.

Параметры:: elementName - имя запрашиваемого элемента.
Возвращает:: наибольшее допустимое значение для атрибута.
Исключения:: IllegalArgumentException - если elementName является null или не является допустимым именем элемента для этого формата.; IllegalArgumentException - если указанный элемент не может содержать значение объекта (т.е., если getObjectValueType(elementName) == VALUE_NONE).; IllegalArgumentException - если Object не определен как диапазон.

Получение минимальной длины массива объектов

int getObjectArrayMinLength(String elementName)

Возвращает минимальное количество элементов массива, которые могут быть использованы для определения Object ссылки в указанном элементе. Этот метод следует вызывать только в том случае, если getObjectValueType возвращает VALUE_LIST.

Параметры:: elementName - имя запрашиваемого элемента.
Возвращает:: наименьшая допустимая длина массива для Object ссылки.
Исключения:: IllegalArgumentException - если elementName является null или не является допустимым именем элемента для этого формата.; IllegalArgumentException - если указанный элемент не может содержать значение объекта (т.е., если getObjectValueType(elementName) == VALUE_NONE).; IllegalArgumentException - если Object не является массивом.

Получение максимальной длины массива объектов

int getObjectArrayMaxLength(String elementName)

Возвращает максимальное количество элементов массива, которые могут быть использованы для определения Object ссылки в указанном элементе. Значение Integer.MAX_VALUE может быть использовано для указания отсутствия верхнего предела. Этот метод следует вызывать только в том случае, если getObjectValueType возвращает VALUE_LIST.

Параметры:: elementName - имя запрашиваемого элемента.
Возвращает:: наибольшая допустимая длина массива для Object ссылки.
Исключения:: IllegalArgumentException - если elementName является null или не является допустимым именем элемента для этого формата.; IllegalArgumentException - если указанный элемент не может содержать значение объекта (т.е., если getObjectValueType(elementName) == VALUE_NONE).; IllegalArgumentException - если Object не является массивом.

© 1993, 2021, 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/17/docs/api/java.desktop/javax/imageio/metadata/IIOMetadataFormat.html