Интерфейс 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` и указывающая, что значение атрибута — одно из логических значений '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

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

См. также:

VALUE_RANGE_MIN_MAX_INCLUSIVE

static final int VALUE_RANGE_MIN_MAX_INCLUSIVE

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

См. также:

VALUE_ENUMERATION

static final int VALUE_ENUMERATION

Константа, возвращаемая getAttributeValueType и getObjectValueType, указывает, что атрибуту или пользовательскому объекту можно присвоить одно из нескольких перечисленных значений. Для атрибутов такими значениями являются Strings; для объектов — Objects, реализующие заданный класс или интерфейс.

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

См. также:

VALUE_LIST

static final int VALUE_LIST

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

См. также:

DATATYPE_STRING

static final int DATATYPE_STRING

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

См. также:

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()

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

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

canNodeAppear

boolean canNodeAppear(String elementName, ImageTypeSpecifier imageType)

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

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

getElementMinChildren

int getElementMinChildren(String elementName)

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

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

getElementMaxChildren

int getElementMaxChildren(String elementName)

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

Параметры:: elementName — имя проверяемого элемента.
Возвращает:: 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)

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

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

getAttributeNames

String[] getAttributeNames(String elementName)

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

Параметры:: elementName — имя проверяемого элемента.
Возвращает:: массив Strings.
Исключения:: 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, если значение по умолчанию недоступно.

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

getAttributeEnumerations

String[] getAttributeEnumerations(String elementName, String attrName)

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

Параметры:: elementName — имя проверяемого элемента.; attrName — имя проверяемого атрибута.
Возвращает:: массив Strings.
Исключения:: IllegalArgumentException — если elementName равно null или не является допустимым именем элемента для этого формата.; IllegalArgumentException — если attrName равно null или не является допустимым именем атрибута для этого элемента.; IllegalArgumentException — если указанный атрибут не определён как перечисление.

getAttributeMinValue

String getAttributeMinValue(String elementName, String attrName)

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

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

getAttributeMaxValue

String getAttributeMaxValue(String elementName, String attrName)

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

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

getAttributeListMinLength

int getAttributeListMinLength(String elementName, String attrName)

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

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

getAttributeListMaxLength

int getAttributeListMaxLength(String elementName, String attrName)

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

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

getAttributeDescription

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

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

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

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

getObjectValueType

int getObjectValueType(String elementName)

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

См. также:

getObjectClass

Class<?> getObjectClass(String elementName)

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

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

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

getObjectDefaultValue

Object getObjectDefaultValue(String elementName)

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

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

getObjectEnumerations

Object[] getObjectEnumerations(String elementName)

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

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

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

getObjectMinValue

Comparable<?> getObjectMinValue(String elementName)

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

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

getObjectMaxValue

Comparable<?> getObjectMaxValue(String elementName)

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

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

getObjectArrayMinLength

int getObjectArrayMinLength(String elementName)

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

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

getObjectArrayMaxLength

int getObjectArrayMaxLength(String elementName)

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

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

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