Класс IIOMetadataFormatImpl

java.lang.Object

javax.imageio.metadata.IIOMetadataFormatImpl

Все реализуемые интерфейсы:: IIOMetadataFormat

public abstract class IIOMetadataFormatImpl extends Object implements IIOMetadataFormat

Конкретный класс, предоставляющий повторно используемую реализацию интерфейса IIOMetadataFormat. Кроме того, метод getStandardFormatInstance предоставляет статический экземпляр, представляющий стандартный, независимый от плагинов формат javax_imageio_1.0.

Для предоставления локализованных описаний элементов и атрибутов следует передать ResourceBundle с базовым именем this.getClass().getName() + "Resources" с помощью обычного механизма, используемого ResourceBundle.getBundle. Кратко говоря, подкласс должен предоставить один или несколько дополнительных классов согласно соглашению об именовании (по умолчанию — полное имя подкласса, расширяющего IIMetadataFormatImpl, за которым следуют строка "Resources" и коды страны, языка и варианта, разделённые символами подчёркивания). Во время выполнения вызовы getElementDescription или getAttributeDescription попытаются динамически загрузить такие классы в соответствии с заданной локалью и использовать в качестве ключа либо имя элемента, либо имя элемента, за которым следует символ '/', а затем имя атрибута. Этот ключ будет передан методу getString объекта ResourceBundle, после чего будет возвращено полученное локализованное описание узла или атрибута.

При необходимости подкласс может указать другое базовое имя пакетов ресурсов с помощью метода setResourceBaseName.

При желании подкласс может использовать собственный механизм локализации, переопределив предоставленные реализации getElementDescription и getAttributeDescription.

См. также:

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

Модификатор и тип	Поле	Описание
`static final String`	`standardMetadataFormatName`	Константа `String`, содержащая имя стандартного формата: `"javax_imageio_1.0"`.

Поля, объявленные в интерфейсе IIOMetadataFormat

CHILD_POLICY_ALL, CHILD_POLICY_CHOICE, CHILD_POLICY_EMPTY, CHILD_POLICY_MAX, CHILD_POLICY_REPEAT, CHILD_POLICY_SEQUENCE, CHILD_POLICY_SOME, DATATYPE_BOOLEAN, DATATYPE_DOUBLE, DATATYPE_FLOAT, DATATYPE_INTEGER, DATATYPE_STRING, VALUE_ARBITRARY, VALUE_ENUMERATION, VALUE_LIST, VALUE_NONE, VALUE_RANGE, VALUE_RANGE_MAX_INCLUSIVE, VALUE_RANGE_MAX_INCLUSIVE_MASK, VALUE_RANGE_MIN_INCLUSIVE, VALUE_RANGE_MIN_INCLUSIVE_MASK, VALUE_RANGE_MIN_MAX_INCLUSIVE

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

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

Конструктор	Описание
`IIOMetadataFormatImpl(String rootName, int childPolicy)`	Создаёт пустой экземпляр `IIOMetadataFormatImpl` с заданным именем корневого элемента и политикой дочерних элементов (отличной от `CHILD_POLICY_REPEAT`).
`IIOMetadataFormatImpl(String rootName, int minChildren, int maxChildren)`	Создаёт пустой экземпляр `IIOMetadataFormatImpl` с заданным именем корневого элемента и политикой дочерних элементов `CHILD_POLICY_REPEAT`.

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

Модификатор и тип	Метод	Описание
`protected void`	`addAttribute(String elementName, String attrName, int dataType, boolean required, int listMinLength, int listMaxLength)`	Добавляет новый атрибут к ранее определённому элементу; атрибут задаётся списком значений.
`protected void`	`addAttribute(String elementName, String attrName, int dataType, boolean required, String defaultValue)`	Добавляет новый атрибут к ранее определённому элементу, которому можно присвоить произвольное значение.
`protected void`	`addAttribute(String elementName, String attrName, int dataType, boolean required, String defaultValue, String minValue, String maxValue, boolean minInclusive, boolean maxInclusive)`	Добавляет новый атрибут к ранее определённому элементу; атрибут задаётся диапазоном значений.
`protected void`	`addAttribute(String elementName, String attrName, int dataType, boolean required, String defaultValue, List<String> enumeratedValues)`	Добавляет новый атрибут к ранее определённому элементу; атрибут задаётся набором перечислимых значений.
`protected void`	`addBooleanAttribute(String elementName, String attrName, boolean hasDefaultValue, boolean defaultValue)`	Добавляет новый атрибут к ранее определённому элементу; атрибут задаётся перечислимыми значениями `TRUE` и `FALSE`, тип данных — `DATATYPE_BOOLEAN`.
`protected void`	`addChildElement(String elementName, String parentName)`	Добавляет существующий элемент в список допустимых дочерних элементов для заданного типа родительского узла.
`protected void`	`addElement(String elementName, String parentName, int childPolicy)`	Добавляет новый тип элемента в формат этого документа метаданных с политикой дочерних элементов, отличной от `CHILD_POLICY_REPEAT`.
`protected void`	`addElement(String elementName, String parentName, int minChildren, int maxChildren)`	Добавляет новый тип элемента в формат этого документа метаданных с политикой дочерних элементов `CHILD_POLICY_REPEAT`.
`protected void`	`addObjectValue(String elementName, Class<?> classType, int arrayMinLength, int arrayMaxLength)`	Разрешает хранить в узлах, реализующих указанный элемент, ссылку `Object` заданного типа класса.
`protected <T> void`	`addObjectValue(String elementName, Class<T> classType, boolean required, T defaultValue)`	Разрешает хранить в узлах, реализующих указанный элемент, ссылку `Object` заданного типа класса.
`protected <T> void`	`addObjectValue(String elementName, Class<T> classType, boolean required, T defaultValue, List<? extends T> enumeratedValues)`	Разрешает хранить в узлах, реализующих указанный элемент, ссылку `Object` заданного типа класса.
`protected <T extends Object & Comparable<? super T>> void`	`addObjectValue(String elementName, Class<T> classType, T defaultValue, Comparable<? super T> minValue, Comparable<? super T> maxValue, boolean minInclusive, boolean maxInclusive)`	Разрешает хранить в узлах, реализующих указанный элемент, ссылку `Object` заданного типа класса.
`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`.
`protected String`	`getResourceBaseName()`	Возвращает текущее базовое имя для поиска `ResourceBundle`.
`String`	`getRootName()`	Возвращает имя корневого элемента формата.
`static IIOMetadataFormat`	`getStandardFormatInstance()`	Возвращает объект `IIOMetadataFormat`, описывающий стандартный формат документа метаданных `javax.imageio_1.0`, независимый от плагинов и описанный в комментарии пакета `javax.imageio.metadata`.
`boolean`	`isAttributeRequired(String elementName, String attrName)`	Возвращает `true`, если указанный атрибут должен присутствовать в указанном элементе.
`protected void`	`removeAttribute(String elementName, String attrName)`	Удаляет атрибут из ранее определённого элемента.
`protected void`	`removeElement(String elementName)`	Удаляет элемент из формата.
`protected void`	`removeObjectValue(String elementName)`	Запрещает хранить ссылку `Object` в узлах, реализующих указанный элемент.
`protected void`	`setResourceBaseName(String resourceBaseName)`	Задаёт новое базовое имя для поиска `ResourceBundle`, содержащих описания элементов и атрибутов этого формата.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Показывает, равен ли этот объект другому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API может быть удалён в будущей версии. Финализация объявлена устаревшей и будет удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо до истечения заданного промежутка реального времени.

Методы, объявленные в интерфейсе IIOMetadataFormat

canNodeAppear

Модификатор и тип	Метод	Описание
`boolean`	`canNodeAppear(String elementName, ImageTypeSpecifier imageType)`	Возвращает `true`, если элемент (и его поддерево) может присутствовать в документе метаданных для изображения заданного типа, определённого с помощью `ImageTypeSpecifier`.

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

standardMetadataFormatName

public static final String standardMetadataFormatName

Константа String, содержащая стандартное имя формата, "javax_imageio_1.0".

См. также:

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

IIOMetadataFormatImpl

public IIOMetadataFormatImpl(String rootName, int childPolicy)

Создает пустой экземпляр IIOMetadataFormatImpl с заданным именем корневого элемента и политикой дочерних элементов (отличной от CHILD_POLICY_REPEAT). Дополнительные элементы, их атрибуты и справочная информация Object могут быть добавлены с помощью различных методов add.

Параметры:: rootName — имя корневого элемента.; childPolicy — одна из констант CHILD_POLICY_*, отличная от CHILD_POLICY_REPEAT.
Исключения:: IllegalArgumentException — если rootName имеет значение null.; IllegalArgumentException — если childPolicy не является одной из предопределенных констант.

IIOMetadataFormatImpl

public IIOMetadataFormatImpl(String rootName, int minChildren, int maxChildren)

Создает пустой экземпляр IIOMetadataFormatImpl с заданным именем корневого элемента и политикой дочерних элементов CHILD_POLICY_REPEAT. Дополнительные элементы, их атрибуты и справочная информация Object могут быть добавлены с помощью различных методов add.

Параметры:: rootName — имя корневого элемента.; minChildren — минимальное количество дочерних элементов узла.; maxChildren — максимальное количество дочерних элементов узла.
Исключения:: IllegalArgumentException — если rootName имеет значение null.; IllegalArgumentException — если minChildren отрицательно или больше maxChildren.

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

setResourceBaseName

protected void setResourceBaseName(String resourceBaseName)

Задает новое базовое имя для поиска ResourceBundle, содержащих описания элементов и атрибутов этого формата.

До первого вызова этого метода базовое имя будет равно this.getClass().getName() + "Resources".

Параметры:

resourceBaseName — String, содержащее новое базовое имя.

Исключения:

IllegalArgumentException — если resourceBaseName имеет значение null.

См. также:

getResourceBaseName

protected String getResourceBaseName()

Возвращает текущее базовое имя для поиска ResourceBundle.

Возвращает:

String, содержащее базовое имя.

См. также:

addElement

protected void addElement(String elementName, String parentName, int childPolicy)

Добавляет в этот формат документа метаданных новый тип элемента с политикой дочерних элементов, отличной от CHILD_POLICY_REPEAT.

Параметры:: elementName — имя нового элемента.; parentName — имя элемента, который будет родительским для нового элемента.; childPolicy — одна из констант CHILD_POLICY_*, отличная от CHILD_POLICY_REPEAT, указывающая политику дочерних элементов нового элемента.
Исключения:: IllegalArgumentException — если parentName имеет значение null или не является допустимым именем элемента для этого формата.; IllegalArgumentException — если childPolicy не является одной из предопределенных констант.

addElement

protected void addElement(String elementName, String parentName, int minChildren, int maxChildren)

Добавляет в этот формат документа метаданных новый тип элемента с политикой дочерних элементов CHILD_POLICY_REPEAT.

Параметры:: elementName — имя нового элемента.; parentName — имя элемента, который будет родительским для нового элемента.; minChildren — минимальное количество дочерних элементов узла.; maxChildren — максимальное количество дочерних элементов узла.
Исключения:: IllegalArgumentException — если parentName имеет значение null или не является допустимым именем элемента для этого формата.; IllegalArgumentException — если minChildren отрицательно или больше maxChildren.

addChildElement

protected void addChildElement(String elementName, String parentName)

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

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

removeElement

protected void removeElement(String elementName)

Удаляет элемент из формата. Если элемента с заданным именем не было, ничего не происходит и исключение не выбрасывается.

Параметры:: elementName — имя удаляемого элемента.

addAttribute

protected void addAttribute(String elementName, String attrName, int dataType, boolean required, String defaultValue)

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

Параметры:: elementName — имя элемента.; attrName — имя добавляемого атрибута.; dataType — тип данных (строковый формат) атрибута, одна из констант DATATYPE_*.; required — true, если атрибут должен присутствовать.; defaultValue — значение атрибута по умолчанию или null.
Исключения:: IllegalArgumentException — если elementName имеет значение null или не является допустимым именем элемента для этого формата.; IllegalArgumentException — если attrName имеет значение null.; IllegalArgumentException — если dataType не является одной из предопределенных констант.

addAttribute

protected void addAttribute(String elementName, String attrName, int dataType, boolean required, String defaultValue, List<String> enumeratedValues)

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

Параметры:: elementName — имя элемента.; attrName — имя добавляемого атрибута.; dataType — тип данных (строковый формат) атрибута, одна из констант DATATYPE_*.; required — true, если атрибут должен присутствовать.; defaultValue — значение атрибута по умолчанию или null.; enumeratedValues — List из String, содержащих допустимые значения атрибута.
Исключения:: IllegalArgumentException — если elementName имеет значение null или не является допустимым именем элемента для этого формата.; IllegalArgumentException — если attrName имеет значение null.; IllegalArgumentException — если dataType не является одной из предопределенных констант.; IllegalArgumentException — если enumeratedValues имеет значение null.; IllegalArgumentException — если enumeratedValues не содержит ни одной записи.; IllegalArgumentException — если enumeratedValues содержит элемент, который не является String или имеет значение null.

addAttribute

protected void addAttribute(String elementName, String attrName, int dataType, boolean required, String defaultValue, String minValue, String maxValue, boolean minInclusive, boolean maxInclusive)

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

Параметры:: elementName — имя элемента.; attrName — имя добавляемого атрибута.; dataType — тип данных (строковый формат) атрибута, одна из констант DATATYPE_*.; required — true, если атрибут должен присутствовать.; defaultValue — значение атрибута по умолчанию или null.; minValue — наименьшее допустимое значение атрибута (включительно или исключительно в зависимости от значения minInclusive), представленное как String.; maxValue — наибольшее допустимое значение атрибута (включительно или исключительно в зависимости от значения minInclusive), представленное как String.; minInclusive — true, если minValue задает включительную границу.; maxInclusive — true, если maxValue задает включительную границу.
Исключения:: IllegalArgumentException — если elementName имеет значение null или не является допустимым именем элемента для этого формата.; IllegalArgumentException — если attrName имеет значение null.; IllegalArgumentException — если dataType не является одной из предопределенных констант.

addAttribute

protected void addAttribute(String elementName, String attrName, int dataType, boolean required, int listMinLength, int listMaxLength)

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

Параметры:: elementName — имя элемента.; attrName — имя добавляемого атрибута.; dataType — тип данных (строковый формат) атрибута, одна из констант DATATYPE_*.; required — true, если атрибут должен присутствовать.; listMinLength — минимально допустимое количество элементов списка.; listMaxLength — максимально допустимое количество элементов списка.
Исключения:: IllegalArgumentException — если elementName имеет значение null или не является допустимым именем элемента для этого формата.; IllegalArgumentException — если attrName имеет значение null.; IllegalArgumentException — если dataType не является одной из предопределенных констант.; IllegalArgumentException — если listMinLength отрицательно или больше listMaxLength.

addBooleanAttribute

protected void addBooleanAttribute(String elementName, String attrName, boolean hasDefaultValue, boolean defaultValue)

Добавляет новый атрибут к ранее определенному элементу, значение которого задается перечислимыми значениями TRUE и FALSE, с типом данных DATATYPE_BOOLEAN.

Параметры:: elementName — имя элемента.; attrName — имя добавляемого атрибута.; hasDefaultValue — true, если должно присутствовать значение по умолчанию.; defaultValue — значение атрибута по умолчанию типа boolean; игнорируется, если hasDefaultValue имеет значение false.
Исключения:: IllegalArgumentException — если elementName имеет значение null или не является допустимым именем элемента для этого формата.; IllegalArgumentException — если attrName имеет значение null.

removeAttribute

protected void removeAttribute(String elementName, String attrName)

Удаляет атрибут из ранее определенного элемента. Если в заданном элементе не было атрибута с указанным именем, ничего не происходит и исключение не выбрасывается.

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

addObjectValue

protected <T> void addObjectValue(String elementName, Class<T> classType, boolean required, T defaultValue)

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

Если ранее была разрешена ссылка Object, предыдущие настройки перезаписываются.

Параметры типа:: T — тип объекта.
Параметры:: elementName — имя элемента.; classType — переменная Class, указывающая допустимый тип класса для значения объекта.; required — true, если значение объекта должно присутствовать.; defaultValue — значение по умолчанию для ссылки Object или null.
Исключения:: IllegalArgumentException — если elementName имеет значение null или не является допустимым именем элемента для этого формата.

addObjectValue

protected <T> void addObjectValue(String elementName, Class<T> classType, boolean required, T defaultValue, List<? extends T> enumeratedValues)

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

Если ранее была разрешена ссылка Object, предыдущие настройки перезаписываются.

Параметры типа:: T — тип объекта.
Параметры:: elementName — имя элемента.; classType — переменная Class, указывающая допустимый тип класса для значения объекта.; required — true, если значение объекта должно присутствовать.; defaultValue — значение по умолчанию для ссылки Object или null.; enumeratedValues — List из Object, содержащих допустимые значения ссылки на объект.
Исключения:: IllegalArgumentException — если elementName имеет значение null или не является допустимым именем элемента для этого формата.; IllegalArgumentException — если enumeratedValues имеет значение null.; IllegalArgumentException — если enumeratedValues не содержит ни одной записи.; IllegalArgumentException — если enumeratedValues содержит элемент, который не является экземпляром типа класса, обозначенного classType, или имеет значение null.

addObjectValue

protected <T extends Object & Comparable<? super T>> void addObjectValue(String elementName, Class<T> classType, T defaultValue, Comparable<? super T> minValue, Comparable<? super T> maxValue, boolean minInclusive, boolean maxInclusive)

Позволяет сохранять ссылку Object заданного типа класса в узлах, реализующих именованный элемент. Значение Object должно находиться в диапазоне, заданном minValue и maxValue. Кроме того, тип класса должен реализовывать интерфейс Comparable.

Если ранее была разрешена ссылка Object, предыдущие настройки перезаписываются.

Параметры типа:: T — тип объекта.
Параметры:: elementName — имя элемента.; classType — переменная Class, указывающая допустимый тип класса для значения объекта.; defaultValue — значение по умолчанию для; minValue — наименьшее допустимое значение для значения объекта (включительно или исключительно в зависимости от значения minInclusive), представленное как String.; maxValue — наибольшее допустимое значение для значения объекта (включительно или исключительно в зависимости от значения minInclusive), представленное как String.; minInclusive — true, если minValue задает включительную границу.; maxInclusive — true, если maxValue задает включительную границу.
Исключения:: IllegalArgumentException — если elementName имеет значение null или не является допустимым именем элемента для этого формата.

addObjectValue

protected void addObjectValue(String elementName, Class<?> classType, int arrayMinLength, int arrayMaxLength)

Позволяет сохранять ссылку Object заданного типа класса в узлах, реализующих именованный элемент. Значение Object должно быть массивом объектов типа класса, заданного classType, содержащим не менее arrayMinLength и не более arrayMaxLength элементов.

Если ранее была разрешена ссылка Object, предыдущие настройки перезаписываются.

Параметры:: elementName — имя элемента.; classType — переменная Class, указывающая допустимый тип класса для значения объекта.; arrayMinLength — минимально допустимая длина массива.; arrayMaxLength — максимально допустимая длина массива.
Исключения:: IllegalArgumentException — если elementName не является допустимым именем элемента для этого формата.

removeObjectValue

protected void removeObjectValue(String elementName)

Запрещает сохранять ссылку Object в узлах, реализующих именованный элемент.

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

getRootName

public String getRootName()

Описание скопировано из интерфейса: IIOMetadataFormat

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

Определено в:: getRootName в интерфейсе IIOMetadataFormat
Возвращает:: объект String.

getElementMinChildren

public int getElementMinChildren(String elementName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Определено в:: getElementMinChildren в интерфейсе IIOMetadataFormat
Параметры:: elementName — имя проверяемого элемента.
Возвращает:: значение int.

getElementMaxChildren

public int getElementMaxChildren(String elementName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Определено в:: getElementMaxChildren в интерфейсе IIOMetadataFormat
Параметры:: elementName — имя проверяемого элемента.
Возвращает:: значение int.

getElementDescription

public String getElementDescription(String elementName, Locale locale)

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

Реализация по умолчанию сначала выполняет поиск ResourceBundle, используя текущее базовое имя ресурса, заданное методом setResourceBaseName, и указанную Locale, с применением механизма резервного выбора, описанного в комментариях к ResourceBundle.getBundle. Если ResourceBundle найден, имя элемента используется как ключ для его метода getString, а результат возвращается. Если ResourceBundle не найден или такого ключа нет, возвращается null.

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

Определено в:

getElementDescription в интерфейсе IIOMetadataFormat

Параметры:

elementName — имя элемента.

locale — Locale, для которого будет предпринята попытка локализации.

Возвращает:

описание элемента.

Исключения:

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

См. также:

getChildPolicy

public int getChildPolicy(String elementName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Определено в:: getChildPolicy в интерфейсе IIOMetadataFormat
Параметры:: elementName — имя проверяемого элемента.
Возвращает:: одну из констант CHILD_POLICY_*.

getChildNames

public String[] getChildNames(String elementName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Определено в:: getChildNames в интерфейсе IIOMetadataFormat
Параметры:: elementName — имя проверяемого элемента.
Возвращает:: массив String или null.

getAttributeNames

public String[] getAttributeNames(String elementName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Определено в:: getAttributeNames в интерфейсе IIOMetadataFormat
Параметры:: elementName — имя проверяемого элемента.
Возвращает:: массив String.

getAttributeValueType

public int getAttributeValueType(String elementName, String attrName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Определено в:: getAttributeValueType в интерфейсе IIOMetadataFormat
Параметры:: elementName — имя проверяемого элемента.; attrName — имя проверяемого атрибута.
Возвращает:: одну из констант VALUE_*.

getAttributeDataType

public int getAttributeDataType(String elementName, String attrName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Определено в:: getAttributeDataType в интерфейсе IIOMetadataFormat
Параметры:: elementName — имя проверяемого элемента.; attrName — имя проверяемого атрибута.
Возвращает:: одну из констант DATATYPE_*.

isAttributeRequired

public boolean isAttributeRequired(String elementName, String attrName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Указано в:: isAttributeRequired в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос.; attrName - имя атрибута, для которого выполняется запрос.
Возвращает:: true, если атрибут должен присутствовать.

getAttributeDefaultValue

public String getAttributeDefaultValue(String elementName, String attrName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Указано в:: getAttributeDefaultValue в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос.; attrName - имя атрибута, для которого выполняется запрос.
Возвращает:: String, содержащее значение по умолчанию, или null.

getAttributeEnumerations

public String[] getAttributeEnumerations(String elementName, String attrName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Указано в:: getAttributeEnumerations в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос.; attrName - имя атрибута, для которого выполняется запрос.
Возвращает:: массив String.

getAttributeMinValue

public String getAttributeMinValue(String elementName, String attrName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Указано в:: getAttributeMinValue в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос.; attrName - имя атрибута, для которого выполняется запрос.
Возвращает:: String, содержащее наименьшее допустимое значение атрибута.

getAttributeMaxValue

public String getAttributeMaxValue(String elementName, String attrName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Указано в:: getAttributeMaxValue в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос, в виде String.; attrName - имя атрибута, для которого выполняется запрос.
Возвращает:: String, содержащее наибольшее допустимое значение атрибута.

getAttributeListMinLength

public int getAttributeListMinLength(String elementName, String attrName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Указано в:: getAttributeListMinLength в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос.; attrName - имя атрибута, для которого выполняется запрос.
Возвращает:: наименьшее допустимое количество элементов списка для атрибута.

getAttributeListMaxLength

public int getAttributeListMaxLength(String elementName, String attrName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Указано в:: getAttributeListMaxLength в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос.; attrName - имя атрибута, для которого выполняется запрос.
Возвращает:: наибольшее допустимое количество элементов списка для атрибута.

getAttributeDescription

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

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

Реализация по умолчанию сначала находит ResourceBundle, используя текущее базовое имя ресурса, заданное с помощью setResourceBaseName, и предоставленный Locale, применяя механизм резервного выбора, описанный в комментариях к ResourceBundle.getBundle. Если ResourceBundle найден, имя элемента, за которым следует символ «/», а затем имя атрибута (elementName + "/" + attrName), используется в качестве ключа для его метода getString, а результат возвращается. Если ResourceBundle не найден или такой ключ отсутствует, возвращается null.

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

Указано в:

getAttributeDescription в интерфейсе IIOMetadataFormat

Параметры:

elementName - имя элемента.

attrName - имя атрибута.

locale - Locale, для которого будет предпринята попытка локализации, или null.

Возвращает:

описание атрибута.

Исключения:

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

IllegalArgumentException - если attrName равно null или не является допустимым именем атрибута для этого элемента.

См. также:

getObjectValueType

public int getObjectValueType(String elementName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

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

Указано в:

getObjectValueType в интерфейсе IIOMetadataFormat

Параметры:

elementName - имя элемента, для которого выполняется запрос.

Возвращает:

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

См. также:

getObjectClass

public Class<?> getObjectClass(String elementName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

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

Указано в:: getObjectClass в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос.
Возвращает:: объект Class.

getObjectDefaultValue

public Object getObjectDefaultValue(String elementName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Указано в:: getObjectDefaultValue в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос.
Возвращает:: Object.

getObjectEnumerations

public Object[] getObjectEnumerations(String elementName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

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

Указано в:: getObjectEnumerations в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос.
Возвращает:: массив Object.

getObjectMinValue

public Comparable<?> getObjectMinValue(String elementName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Указано в:: getObjectMinValue в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос.
Возвращает:: наименьшее допустимое значение атрибута.

getObjectMaxValue

public Comparable<?> getObjectMaxValue(String elementName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Указано в:: getObjectMaxValue в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос.
Возвращает:: наименьшее допустимое значение атрибута.

getObjectArrayMinLength

public int getObjectArrayMinLength(String elementName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Указано в:: getObjectArrayMinLength в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос.
Возвращает:: наименьшую допустимую длину массива для ссылки Object.

getObjectArrayMaxLength

public int getObjectArrayMaxLength(String elementName)

Описание скопировано из интерфейса: IIOMetadataFormat

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

Указано в:: getObjectArrayMaxLength в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, для которого выполняется запрос.
Возвращает:: наибольшую допустимую длину массива для ссылки Object.

getStandardFormatInstance

public static IIOMetadataFormat getStandardFormatInstance()

Возвращает объект IIOMetadataFormat, описывающий стандартный формат документа метаданных javax.imageio_1.0, независимый от подключаемых модулей и описанный в комментарии к пакету javax.imageio.metadata.

Возвращает:: предопределённый экземпляр IIOMetadataFormat.

© 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.