Класс 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's getString, и возвращается локализованное описание узла или атрибута.

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

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

См. также:: ResourceBundle.getBundle(String,Locale)

Поля

Модификатор и тип	Поле и описание
`static 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, List<String> enumeratedValues)` Добавляет новый атрибут к ранее определённому элементу, который будет определён набором перечисленных значений.
`protected void`	`addAttribute(String elementName, String attrName, int dataType, boolean required, String defaultValue, String minValue, String maxValue, boolean minInclusive, boolean maxInclusive)` Добавляет новый атрибут к ранее определённому элементу, который будет определён диапазоном значений.
`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` заданного типа класса в узлах, реализующих указанный элемент.
`abstract 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`.
`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

Поля

standardMetadataFormatName

public static final String standardMetadataFormatName

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

См. также:: Constant Field Values

Конструкторы

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

getResourceBaseName

protected String getResourceBaseName()

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

Возвращает:: String, содержащий базовое имя.
См. также:: setResourceBaseName(java.lang.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)

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

Параметры:: parentName - имя элемента, который будет новым родителем элемента.; elementName - имя элемента, который будет добавлен как дочерний.
Исключения:: 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.

canNodeAppear

public abstract boolean canNodeAppear(String elementName,
                                      ImageTypeSpecifier imageType)

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

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

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

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, или не является допустимым именем элемента для этого формата.
См. также:: setResourceBaseName(java.lang.String)

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, или не является законным именем атрибута для данного элемента.
См. также:: setResourceBaseName(java.lang.String)

getObjectValueType

public int getObjectValueType(String elementName)

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

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

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

Установлено:: getObjectValueType в интерфейсе IIOMetadataFormat
Параметры:: elementName - имя элемента, который запрашивается.
Возвращает:: одно из VALUE_* констант.
См. также:: Comparable

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, 2020, 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.