Интерфейс 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`, указывающая, что значение атрибута — общая строка Юникода.
`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 должны быть помечены как перечисления.

См. также:

СПИСОК_ЗНАЧЕНИЙ

static final int VALUE_LIST

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

См. также:

ТИП_ДАННЫХ_СТРОКА

static final int DATATYPE_STRING

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

См. также:

ТИП_ДАННЫХ_ЛОГИЧЕСКИЙ

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

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

Возвращает:: 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)

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

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

getAttributeNames

String[] getAttributeNames(String elementName)

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

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

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

isAttributeRequired

boolean isAttributeRequired(String elementName, String attrName)

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

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

getObjectEnumerations

Object[] getObjectEnumerations(String elementName)

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

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

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

getObjectMinValue

Comparable<?> getObjectMinValue(String elementName)

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

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

getObjectMaxValue

Comparable<?> getObjectMaxValue(String elementName)

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

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

getObjectArrayMinLength

int getObjectArrayMinLength(String elementName)

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

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

getObjectArrayMaxLength

int getObjectArrayMaxLength(String elementName)

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

Parameters:: elementName - имя элемента, который запрашивается.
Returns:: наибольшая допустимая длина массива для ссылки Object.
Throws:: 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/imageio/metadata/IIOMetadataFormat.html