Класс IIOMetadataFormatImpl

java.lang.Object

javax.imageio.metadata.IIOMetadataFormatImpl

Все реализованные интерфейсы:: IIOMetadataFormat

public abstract class IIOMetadataFormatImpl extends Object implements IIOMetadataFormat

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

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

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

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

См. также:

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

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

Поля, объявленные в интерфейсе javax.imageio.metadata.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

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

Конструктор	Описание
`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`, содержащих описания элементов и атрибутов для этого формата.

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

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

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

canNodeAppear

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

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 - строка, содержащая новое имя базы.

Исключения:

IllegalArgumentException - если resourceBaseName равно null.

См. также:

getResourceBaseName

protected String getResourceBaseName()

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

Возвращает:

строку, содержащую имя базы.

См. также:

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 должно быть массивом объектов типа класса, заданного classType, с количеством элементов не менее arrayMinLength и не более arrayMaxLength.

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

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

removeObjectValue

protected void removeObjectValue(String elementName)

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

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

getRootName

public String getRootName()

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

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

Specified by:: getRootName в интерфейсе IIOMetadataFormat
Returns:: строка String.

getElementMinChildren

public int getElementMinChildren(String elementName)

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

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

Specified by:: getElementMinChildren в интерфейсе IIOMetadataFormat
Parameters:: elementName - имя запрашиваемого элемента.
Returns:: целое число int.

getElementMaxChildren

public int getElementMaxChildren(String elementName)

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

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

Specified by:: getElementMaxChildren в интерфейсе IIOMetadataFormat
Parameters:: elementName - имя запрашиваемого элемента.
Returns:: целое число 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.

Specified by:

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

Parameters:

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

locale - Locale для которого будет осуществлена локализация.

Returns:

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

Throws:

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

See Also:

getChildPolicy

public int getChildPolicy(String elementName)

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

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

Specified by:: getChildPolicy в интерфейсе IIOMetadataFormat
Parameters:: elementName - имя запрашиваемого элемента.
Returns:: одна из констант CHILD_POLICY_*.

getChildNames

public String[] getChildNames(String elementName)

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

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

Specified by:: getChildNames в интерфейсе IIOMetadataFormat
Parameters:: elementName - имя запрашиваемого элемента.
Returns:: массив строк String или null.

getAttributeNames

public String[] getAttributeNames(String elementName)

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

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

Specified by:: getAttributeNames в интерфейсе IIOMetadataFormat
Parameters:: elementName - имя запрашиваемого элемента.
Returns:: массив строк String.

getAttributeValueType

public int getAttributeValueType(String elementName, String attrName)

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

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

Specified by:: getAttributeValueType в интерфейсе IIOMetadataFormat
Parameters:: elementName - имя запрашиваемого элемента.; attrName - имя запрашиваемого атрибута.
Returns:: одна из констант VALUE_*.

getAttributeDataType

public int getAttributeDataType(String elementName, String attrName)

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

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

Specified by:: getAttributeDataType в интерфейсе IIOMetadataFormat
Parameters:: elementName - имя запрашиваемого элемента.; attrName - имя запрашиваемого атрибута.
Returns:: одна из констант DATATYPE_*.

isAttributeRequired

public boolean isAttributeRequired(String elementName, String attrName)

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

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

Specified by:: isAttributeRequired в интерфейсе IIOMetadataFormat
Parameters:: elementName - имя запрашиваемого элемента.; attrName - имя запрашиваемого атрибута.
Returns:: 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. Если Locale найден, имя элемента, за которым следует символ "/" и имя атрибута (elementName + "/" + attrName), будет использоваться в качестве ключа для его метода getString, и результат будет возвращен. Если Locale не найден, или такого ключа нет, будет возвращено значение 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).

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

getObjectMinValue

public Comparable<?> getObjectMinValue(String elementName)

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

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

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

getObjectMaxValue

public Comparable<?> getObjectMaxValue(String elementName)

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

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

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

getObjectArrayMinLength

public int getObjectArrayMinLength(String elementName)

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

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

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

getObjectArrayMaxLength

public int getObjectArrayMaxLength(String elementName)

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

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

Specified by:: 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.
https://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/imageio/metadata/IIOMetadataFormatImpl.html