Класс IIOMetadataFormatImpl

public static final String standardMetadataFormatName

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

public IIOMetadataFormatImpl(String rootName, int childPolicy)

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

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

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

protected void setResourceBaseName(String resourceBaseName)

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

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

protected String getResourceBaseName()

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

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 addChildElement(String elementName, String parentName)

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

protected void removeElement(String elementName)

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

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 addAttribute(String elementName, String attrName, int dataType, boolean required, int listMinLength, int listMaxLength)

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

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

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

protected void removeAttribute(String elementName, String attrName)

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

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

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

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

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

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

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

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)

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

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

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

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

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

protected void removeObjectValue(String elementName)

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

public String getRootName()

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

public int getElementMinChildren(String elementName)

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

public int getElementMaxChildren(String elementName)

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

public String getElementDescription(String elementName, Locale locale)

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

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

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

public int getChildPolicy(String elementName)

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

public String[] getChildNames(String elementName)

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

public String[] getAttributeNames(String elementName)

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

public int getAttributeValueType(String elementName, String attrName)

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

public int getAttributeDataType(String elementName, String attrName)

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

public boolean isAttributeRequired(String elementName, String attrName)

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

public String getAttributeDefaultValue(String elementName, String attrName)

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

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

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

public String getAttributeMinValue(String elementName, String attrName)

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

public String getAttributeMaxValue(String elementName, String attrName)

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

public int getAttributeListMinLength(String elementName, String attrName)

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

public int getAttributeListMaxLength(String elementName, String attrName)

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

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.

public int getObjectValueType(String elementName)

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

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

public Class<?> getObjectClass(String elementName)

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

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

public Object getObjectDefaultValue(String elementName)

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

public Object[] getObjectEnumerations(String elementName)

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

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

public Comparable<?> getObjectMinValue(String elementName)

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

public Comparable<?> getObjectMaxValue(String elementName)

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

public int getObjectArrayMinLength(String elementName)

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

public int getObjectArrayMaxLength(String elementName)

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

public static IIOMetadataFormat getStandardFormatInstance()

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