Класс IIOMetadataFormatImpl

public static final String standardMetadataFormatName

См. также:

• Значения константных полей

public IIOMetadataFormatImpl(String rootName, int childPolicy)

Параметры:

rootName — имя корневого элемента.

childPolicy — одна из констант CHILD_POLICY_*, отличная от CHILD_POLICY_REPEAT.

Исключения:

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

IllegalArgumentException — если childPolicy не является одной из предопределённых констант.

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

Параметры:

rootName — имя корневого элемента.

minChildren — минимальное количество дочерних элементов узла.

maxChildren — максимальное количество дочерних элементов узла.

Исключения:

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

IllegalArgumentException — если minChildren отрицательно или превышает maxChildren.

protected void setResourceBaseName(String resourceBaseName)

Параметры:

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

Исключения:

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

См. также:

• getResourceBaseName()

protected String getResourceBaseName()

Возвращает:

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

См. также:

• setResourceBaseName(String)

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

Параметры:

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

parentName — имя элемента, который будет родительским для нового элемента.

childPolicy — одна из констант CHILD_POLICY_*, отличная от CHILD_POLICY_REPEAT, указывающая политику дочерних элементов нового элемента.

Исключения:

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

IllegalArgumentException — если childPolicy не является одной из предопределённых констант.

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

Параметры:

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

parentName — имя элемента, который будет родительским для нового элемента.

minChildren — минимальное количество дочерних элементов узла.

maxChildren — максимальное количество дочерних элементов узла.

Исключения:

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

IllegalArgumentException — если minChildren отрицательно или превышает maxChildren.

protected void addChildElement(String elementName, String parentName)

Параметры:

elementName — имя элемента, добавляемого в качестве дочернего.

parentName — имя элемента, который станет новым родительским элементом.

Исключения:

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

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

protected void removeElement(String elementName)

Параметры:

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

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 не является одной из предопределённых констант.

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.

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 не является одной из предопределённых констант.

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.

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

Параметры:

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

attrName — имя добавляемого атрибута.

hasDefaultValue — true, если должно быть задано значение по умолчанию.

defaultValue — значение атрибута по умолчанию в виде boolean; игнорируется, если hasDefaultValue имеет значение false.

Исключения:

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

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

protected void removeAttribute(String elementName, String attrName)

Параметры:

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

attrName — имя удаляемого атрибута.

Исключения:

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

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

Параметры типа:

T — тип объекта.

Параметры:

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

classType — переменная Class, указывающая допустимый тип класса для значения объекта.

required — true, если значение объекта должно присутствовать.

defaultValue — значение по умолчанию для ссылки Object или null.

Исключения:

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

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

Параметры типа:

T — тип объекта.

Параметры:

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

classType — переменная Class, указывающая допустимый тип класса для значения объекта.

required — true, если значение объекта должно присутствовать.

defaultValue — значение по умолчанию для ссылки Object или null.

enumeratedValues — List из Object, содержащих допустимые значения ссылки на объект.

Исключения:

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

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

IllegalArgumentException — если enumeratedValues не содержит ни одной записи.

IllegalArgumentException — если enumeratedValues содержит элемент, который не является экземпляром типа класса, обозначенного classType, или имеет значение null.

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)

Параметры типа:

T — тип объекта.

Параметры:

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

classType — переменная Class, указывающая допустимый тип класса для значения объекта.

defaultValue — значение по умолчанию для

minValue — наименьшее допустимое значение для значения объекта (включительно или исключительно в зависимости от значения minInclusive), представленное как String.

maxValue — наибольшее допустимое значение для значения объекта (включительно или исключительно в зависимости от значения minInclusive), представленное как String.

minInclusive — true, если minValue является включительной границей.

maxInclusive — true, если maxValue является включительной границей.

Исключения:

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

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

Параметры:

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

classType — переменная Class, указывающая допустимый тип класса для значения объекта.

arrayMinLength — наименьшая допустимая длина массива.

arrayMaxLength — наибольшая допустимая длина массива.

Исключения:

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

protected void removeObjectValue(String elementName)

Параметры:

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

Исключения:

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

public String getRootName()

Определён в:

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

Возвращает:

String.

public int getElementMinChildren(String elementName)

Определён в:

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

Параметры:

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

Возвращает:

int.

public int getElementMaxChildren(String elementName)

Определён в:

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

Параметры:

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

Возвращает:

int.

public String getElementDescription(String elementName, Locale locale)

Определён в:

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

Параметры:

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

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

Возвращает:

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

Исключения:

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

См. также:

• setResourceBaseName(String)

public int getChildPolicy(String elementName)

Определён в:

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

Параметры:

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

Возвращает:

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

public String[] getChildNames(String elementName)

Определён в:

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

Параметры:

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

Возвращает:

массив String или null.

public String[] getAttributeNames(String elementName)

Определён в:

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

Параметры:

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

Возвращает:

массив String.

public int getAttributeValueType(String elementName, String attrName)

Определён в:

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

Параметры:

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

attrName — имя атрибута, для которого выполняется запрос.

Возвращает:

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

public int getAttributeDataType(String elementName, String attrName)

Определён в:

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

Параметры:

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

attrName — имя атрибута, для которого выполняется запрос.

Возвращает:

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

public boolean isAttributeRequired(String elementName, String attrName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

attrName — имя проверяемого атрибута.

Возвращает:

true, если атрибут должен присутствовать.

public String getAttributeDefaultValue(String elementName, String attrName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

attrName — имя проверяемого атрибута.

Возвращает:

String, содержащее значение по умолчанию, или null.

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

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

attrName — имя проверяемого атрибута.

Возвращает:

массив String.

public String getAttributeMinValue(String elementName, String attrName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

attrName — имя проверяемого атрибута.

Возвращает:

String, содержащее наименьшее допустимое значение атрибута.

public String getAttributeMaxValue(String elementName, String attrName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента в виде String.

attrName — имя проверяемого атрибута.

Возвращает:

String, содержащее наибольшее допустимое значение атрибута.

public int getAttributeListMinLength(String elementName, String attrName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

attrName — имя проверяемого атрибута.

Возвращает:

наименьшее допустимое число элементов списка для атрибута.

public int getAttributeListMaxLength(String elementName, String attrName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

attrName — имя проверяемого атрибута.

Возвращает:

наибольшее допустимое число элементов списка для атрибута.

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

Указано в:

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

Параметры:

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

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

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

Возвращает:

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

Исключения:

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

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

См. также:

• setResourceBaseName(String)

public int getObjectValueType(String elementName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

Возвращает:

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

См. также:

• Comparable

public Class<?> getObjectClass(String elementName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

Возвращает:

объект Class.

public Object getObjectDefaultValue(String elementName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

Возвращает:

Object.

public Object[] getObjectEnumerations(String elementName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

Возвращает:

массив Object.

public Comparable<?> getObjectMinValue(String elementName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

Возвращает:

наименьшее допустимое значение атрибута.

public Comparable<?> getObjectMaxValue(String elementName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

Возвращает:

наименьшее допустимое значение атрибута.

public int getObjectArrayMinLength(String elementName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

Возвращает:

наименьшую допустимую длину массива для ссылки Object.

public int getObjectArrayMaxLength(String elementName)

Указано в:

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

Параметры:

elementName — имя проверяемого элемента.

Возвращает:

наибольшую допустимую длину массива для ссылки Object.

public static IIOMetadataFormat getStandardFormatInstance()

Возвращает:

предопределенный экземпляр IIOMetadataFormat.