Интерфейс 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

См. также:

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, указывающая, что значение атрибута является универсальной строкой Unicode.

См. также:

Тип_данных_БУЛЕВО

static final int DATATYPE_BOOLEAN

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

См. также:

Тип_данных_ЦЕЛОЕ

static final int DATATYPE_INTEGER

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

См. также:

Тип_данных_ВЕЩЕСТВЕННОЕ

static final int DATATYPE_FLOAT

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

См. также:

Тип_данных_ДВОЙНАЯ_ТОЧНОСТЬ

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)

Возвращает массив 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 если значение по умолчанию недоступно.

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:

getObjectClass

Class<?> getObjectClass(String elementName)

Возвращает тип Class ссылки Object хранящейся в элементе. Если данный элемент не может содержать ссылку на Object, будет выброшено исключение IllegalArgumentException. Если тип класса является массивом, это поле указывает на тип базового класса (например, для массива ints, этот метод вернёт 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, 2023, 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/21/docs/api/java.desktop/javax/imageio/metadata/IIOMetadataFormat.html