Класс IIOMetadataFormatImpl

public static final String standardMetadataFormatName

Константа, содержащая стандартное имя формата, "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)

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

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

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)

Позволяет хранить ссылку на объект заданного типа в узлах, реализующих указанный элемент. Значение Object должно быть массивом объектов класса, указанного в 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)

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

public String[] getAttributeNames(String elementName)

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

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)

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

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

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

public String getAttributeMinValue(String elementName, String attrName)

Возвращает минимальное допустимое значение для атрибута. Включительно или исключающее это значение можно определить по значению getAttributeValueType. Значение возвращается как String; его интерпретация зависит от значения 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()

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