IIOMetadataFormat (Java Platform SE 8 )-立地货

所有已知实现类：

IIOMetadataFormatImpl
```
public interface IIOMetadataFormat
```
描述从IIOMetadata.getAsTree返回并传递给IIOMetadata.setFromTree和mergeTree的元数据文件的结构的对象。文档结构是由一组的类型和可能属于一个给定的父元素类型，名称，类型，以及可能属于一个元素的属性值的子元素的数目的限制，并且类型和值的说明Object可以存储在节点处的引用。
注意：实现此接口的类应该包含一个声明为public static getInstance()的方法，它返回该类的一个实例。通常，一个实现将仅构造一个实例并将其缓存以供将来调用getInstance 。

可以由此类描述的结构是使用XML文档类型定义（DTD）可表达的结构的一个子集，其中添加了关于属性的数据类型的一些基本信息以及在节点中存储Object引用的能力。将来，XML Schemas可以用于表示这些结构，还有许多其他结构。

IIOMetadataFormat描述结构与DTD之间的IIOMetadataFormat如下：
- 元素可能不包含文本或使用嵌入的标签混合文本。
- 元素的孩子必须符合的几个简单的模式之一，用于在文档中描述CHILD_*常量;
- 元素的内存中表示可能包含对Object的Object 。没有规定文字表示这些对象。

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CHILD_POLICY_ALL` 由 `getChildPolicy`返回的 `getChildPolicy`表示元素必须具有每个合法子元素的单个实例。
`static int`	`CHILD_POLICY_CHOICE` 由 `getChildPolicy`返回的 `getChildPolicy`表示元素必须有零个或一个小孩，从其合法的子元素中选择。
`static int`	`CHILD_POLICY_EMPTY` 由 `getChildPolicy`返回的 `getChildPolicy`表示某个元素可能没有任何子项。
`static int`	`CHILD_POLICY_MAX` 最大有效的 `CHILD_POLICY_*`常数，用于范围检查。
`static int`	`CHILD_POLICY_REPEAT` 由 `getChildPolicy`返回的 `getChildPolicy`表示元素必须具有零个或多个独特的合法子元素的实例。
`static int`	`CHILD_POLICY_SEQUENCE` 由 `getChildPolicy`返回的 `getChildPolicy`表示元素必须具有任何其合法子元素的实例序列。
`static int`	`CHILD_POLICY_SOME` 由 `getChildPolicy`返回的 `getChildPolicy`表示元素必须按顺序具有每个合法子元素的零个或一个实例。
`static int`	`DATATYPE_BOOLEAN` 由 `getAttributeDataType`返回的 `getAttributeDataType`属性的值是布尔值“true”或“false”之一。
`static int`	`DATATYPE_DOUBLE` 一个由 `getAttributeDataType`返回的常量， `getAttributeDataType`属性的值是双精度十进制浮点数的字符串表示形式。
`static int`	`DATATYPE_FLOAT` 由 `getAttributeDataType`返回的常数 `getAttributeDataType`属性的值是十进制浮点数的字符串表示形式。
`static int`	`DATATYPE_INTEGER` 的常量，返回 `getAttributeDataType`指示属性的值是一个整数的字符串表示。
`static int`	`DATATYPE_STRING` 由 `getAttributeDataType`返回的常数 `getAttributeDataType`属性的值是一般的Unicode字符串。
`static int`	`VALUE_ARBITRARY` 由 `getAttributeValueType`和 `getObjectValueType`返回的常数表示可以将属性或用户对象设置为单个任意值。
`static int`	`VALUE_ENUMERATION` 由 `getAttributeValueType`和 `getObjectValueType`返回的常数表示可以将属性或用户对象设置为多个枚举值之一。
`static int`	`VALUE_LIST` 由 `getAttributeValueType`和 `getObjectValueType`返回的常数表示可以将属性或用户对象设置为值列表或数组。
`static int`	`VALUE_NONE` 常数由 `getObjectValueType`返回，表示没有用户对象。
`static int`	`VALUE_RANGE` 由 `getAttributeValueType`和 `getObjectValueType`返回的常数表示可以将属性或用户对象设置为值范围。
`static int`	`VALUE_RANGE_MAX_INCLUSIVE` 由 `getAttributeValueType`和 `getObjectValueType`返回的常数表示可以将属性或用户对象设置为一定范围的值。
`static int`	`VALUE_RANGE_MAX_INCLUSIVE_MASK` 一个值可以用 `VALUE_RANGE`获得 `VALUE_RANGE_MAX_INCLUSIVE` ，并用 `VALUE_RANGE_MIN_INCLUSIVE`获得 `VALUE_RANGE_MIN_MAX_INCLUSIVE` 。
`static int`	`VALUE_RANGE_MIN_INCLUSIVE` 由 `getAttributeValueType`和 `getObjectValueType`返回的常数表示可以将属性或用户对象设置为值范围。
`static int`	`VALUE_RANGE_MIN_INCLUSIVE_MASK` 可与被或运算的值 `VALUE_RANGE`获得 `VALUE_RANGE_MIN_INCLUSIVE` ，并用 `VALUE_RANGE_MAX_INCLUSIVE`获得 `VALUE_RANGE_MIN_MAX_INCLUSIVE` 。
`static int`	`VALUE_RANGE_MIN_MAX_INCLUSIVE` 由 `getAttributeValueType`和 `getObjectValueType`返回的常数表示可以将属性或用户对象设置为一个值范围。

方法摘要

所有方法接口方法抽象方法
Modifier and Type	Method and Description
`boolean`	`canNodeAppear(String elementName, ImageTypeSpecifier imageType)` 返回 `true`如果元素（及其下面的子树）被允许出现在由 `ImageTypeSpecifier`定义的给定类型的图像的元数据文档中。
`int`	`getAttributeDataType(String elementName, String attrName)` 返回以DATATYPE_开头的 `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_开头的 `VALUE_` ，指示指定元素中给定属性的值是否是任意的，被限制在指定范围内，被限制为一组枚举值中的一个，或者是空格分隔的列表的任意值。
`String[]`	`getChildNames(String elementName)` 返回一个 `String` s的数组，它们按照它们应该出现的顺序指示被允许为指定元素的子元素的元素的名称。
`int`	`getChildPolicy(String elementName)` 返回以CHILD_POLICY_开头的 `CHILD_POLICY_` ，表示指定元素的子代码的合法模式。
`String`	`getElementDescription(String elementName, Locale locale)` 返回一个 `String`含有指定元素，或的描述 `null` 。
`int`	`getElementMaxChildren(String elementName)` 返回具有子策略 `CHILD_POLICY_REPEAT`的命名元素的最大子 `CHILD_POLICY_REPEAT` 。
`int`	`getElementMinChildren(String elementName)` 返回具有子策略 `CHILD_POLICY_REPEAT`的named元素的最 `CHILD_POLICY_REPEAT` 。
`int`	`getObjectArrayMaxLength(String elementName)` 返回可用于定义指定元素中 `Object`引用的最大数组元素数。
`int`	`getObjectArrayMinLength(String elementName)` 返回可用于定义指定元素中 `Object`引用的最小数组元素数。
`类<?>`	`getObjectClass(String elementName)` 返回 `类`类型的 `Object`参考存储在元素内。
`Object`	`getObjectDefaultValue(String elementName)` 返回一个 `Object` s，其中 `Object`命名元素中的 `Object`引用的默认值。
`Object[]`	`getObjectEnumerations(String elementName)` 返回一个包含指定元素中 `Object`引用的合法枚举值的 `Object` Object。
`Comparable<?>`	`getObjectMaxValue(String elementName)` 返回指定元素中 `Object`引用的最大合法值。
`Comparable<?>`	`getObjectMinValue(String elementName)` 返回指定元素中 `Object`引用的最小合法值。
`int`	`getObjectValueType(String elementName)` 返回以所列举的值中的一个 `VALUE_` ，指示所允许的值（枚举，范围或阵列）的种类 `Object`参考。
`String`	`getRootName()` 返回格式的根元素的名称。
`boolean`	`isAttributeRequired(String elementName, String attrName)` 如果命名的属性必须存在于命名的元素中，则返回 `true` 。

- 字段详细信息
  - CHILD_POLICY_EMPTY
```
static final int CHILD_POLICY_EMPTY
```
    由getChildPolicy返回的getChildPolicy表示元素可能没有任何子项。换句话说，它需要是叶节点。
    
    另请参见：
    
    Constant Field Values
  - CHILD_POLICY_ALL
```
static final int CHILD_POLICY_ALL
```
    由getChildPolicy返回的getChildPolicy表示元素必须具有每个合法子元素的单个实例。在DTD术语中，元素的内容由序列a,b,c,d,...定义。
    
    另请参见：
    
    Constant Field Values
  - CHILD_POLICY_SOME
```
static final int CHILD_POLICY_SOME
```
    由getChildPolicy返回的getChildPolicy表示元素必须具有每个其合法子元素的零个或一个实例。在DTD术语中，元素的内容由序列a?,b?,c?,d?,...定义。
    
    另请参见：
    
    Constant Field Values
  - CHILD_POLICY_CHOICE
```
static final int CHILD_POLICY_CHOICE
```
    由getChildPolicy返回的getChildPolicy表示一个元素必须有零个或一个孩子，从其合法的子元素中选择。在DTD术语中，元素的内容由选择a|b|c|d|... a|b|c|d|... 。
    
    另请参见：
    
    Constant Field Values
  - CHILD_POLICY_SEQUENCE
```
static final int CHILD_POLICY_SEQUENCE
```
    一个由getChildPolicy返回的getChildPolicy ，表示一个元素必须具有其任何法定子元素的一系列实例。在DTD术语中，元素的内容由序列(a|b|c|d|...)*定义。
    
    另请参见：
    
    Constant Field Values
  - CHILD_POLICY_REPEAT
```
static final int CHILD_POLICY_REPEAT
```
    由getChildPolicy返回的getChildPolicy表示元素必须具有其独特的合法子元素的零个或多个实例。在DTD术语中，元素的内容由星号表达式a*定义。
    
    另请参见：
    
    Constant Field Values
  - CHILD_POLICY_MAX
```
static final int CHILD_POLICY_MAX
```
    最大有效 CHILD_POLICY_*常数，用于范围检查。
    
    另请参见：
    
    Constant Field Values
  - VALUE_NONE
```
static final int VALUE_NONE
```
    由 getObjectValueType返回的 getObjectValueType表示没有用户对象。
    
    另请参见：
    
    Constant Field Values
  - VALUE_ARBITRARY
```
static final int VALUE_ARBITRARY
```
    一个由 getAttributeValueType和 getObjectValueType返回的 getAttributeValueType ，用于指示属性或用户对象可以设置为单个任意值。
    
    另请参见：
    
    Constant Field Values
  - VALUE_RANGE
```
static final int VALUE_RANGE
```
    由getAttributeValueType和getObjectValueType返回的常数表示可以将属性或用户对象设置为一个值范围。范围的最小值和最大值都是独占的。建议两端的整数范围是包含的，唯一的范围只能用于浮点数据。
    
    另请参见：
    
    VALUE_RANGE_MIN_MAX_INCLUSIVE ， Constant Field Values
  - VALUE_RANGE_MIN_INCLUSIVE_MASK
```
static final int VALUE_RANGE_MIN_INCLUSIVE_MASK
```
    可以用VALUE_RANGE取得VALUE_RANGE_MIN_INCLUSIVE一个值，并用VALUE_RANGE_MAX_INCLUSIVE获得VALUE_RANGE_MIN_MAX_INCLUSIVE 。
    类似地，该值可以和值为getAttributeValueType或getObjectValueType以确定该范围的最小值是否包括在内。
    
    另请参见：
    
    Constant Field Values
  - VALUE_RANGE_MAX_INCLUSIVE_MASK
```
static final int VALUE_RANGE_MAX_INCLUSIVE_MASK
```
    可以用VALUE_RANGE取得VALUE_RANGE_MAX_INCLUSIVE一个值，并用VALUE_RANGE_MIN_INCLUSIVE获得VALUE_RANGE_MIN_MAX_INCLUSIVE 。
    类似地，该值可以为getAttributeValueType或getObjectValueType的值，以确定范围的最大值是否包含在内。
    
    另请参见：
    
    Constant Field Values
  - VALUE_RANGE_MIN_INCLUSIVE
```
static final int VALUE_RANGE_MIN_INCLUSIVE
```
    由getAttributeValueType和getObjectValueType返回的常数表示可以将属性或用户对象设置为一定范围的值。范围的最小值（但不是最大值）是包含值。
    
    另请参见：
    
    Constant Field Values
  - VALUE_RANGE_MAX_INCLUSIVE
```
static final int VALUE_RANGE_MAX_INCLUSIVE
```
    由getAttributeValueType和getObjectValueType返回的常数表示可以将属性或用户对象设置为一个值范围。范围的最大值（但不是最小值）是包含值。
    
    另请参见：
    
    Constant Field Values
  - VALUE_RANGE_MIN_MAX_INCLUSIVE
```
static final int VALUE_RANGE_MIN_MAX_INCLUSIVE
```
    由getAttributeValueType和getObjectValueType返回的常数表示可以将属性或用户对象设置为一个值范围。范围的最小值和最大值都是包含值。建议两端的整数范围是包含的，唯一的范围只能用于浮点数据。
    
    另请参见：
    
    Constant Field Values
  - VALUE_ENUMERATION
```
static final int VALUE_ENUMERATION
```
    一个由getAttributeValueType和getObjectValueType返回的getAttributeValueType ，用于指示属性或用户对象可以设置为多个枚举值之一。在属性的情况下，这些值为String s; 对于对象，它们是Object s实现给定的类或接口。
    类型DATATYPE_BOOLEAN属性值应标记为枚举。
    
    另请参见：
    
    Constant Field Values
  - VALUE_LIST
```
static final int VALUE_LIST
```
    由getAttributeValueType和getObjectValueType返回的getAttributeValueType ，用于指示属性或用户对象可能被设置为列表或数组。在属性的情况下，列表将由String中的空格分隔值String ; 对于对象，将使用数组。
    
    另请参见：
    
    Constant Field Values
  - DATATYPE_STRING
```
static final int DATATYPE_STRING
```
    一个由 getAttributeDataType返回的常量， getAttributeDataType属性的值是一般的Unicode字符串。
    
    另请参见：
    
    Constant Field Values
  - DATATYPE_BOOLEAN
```
static final int DATATYPE_BOOLEAN
```
    由getAttributeDataType返回的getAttributeDataType属性的值是布尔值“true”或“false”之一。类型为DATATYPE_BOOLEAN的属性值应该被标记为枚举，并且允许的值应该是字符串文字值“TRUE”或“FALSE”，尽管插件也可以识别较低或混合的大小写等价物。
    
    另请参见：
    
    Constant Field Values
  - DATATYPE_INTEGER
```
static final int DATATYPE_INTEGER
```
    由 getAttributeDataType返回的 getAttributeDataType属性的值是整数的字符串表示形式。
    
    另请参见：
    
    Constant Field Values
  - DATATYPE_FLOAT
```
static final int DATATYPE_FLOAT
```
    由 getAttributeDataType返回的常数 getAttributeDataType属性的值是十进制浮点数的字符串表示形式。
    
    另请参见：
    
    Constant Field Values
  - DATATYPE_DOUBLE
```
static final int DATATYPE_DOUBLE
```
    由 getAttributeDataType返回的 getAttributeDataType属性的值是双精度十进制浮点数的字符串表示形式。
    
    另请参见：
    
    Constant Field Values
- 方法详细信息
  - getRootName
```
String getRootName()
```
    返回格式的根元素的名称。
    
    结果
    
    一个 String 。
  - canNodeAppear
```
boolean canNodeAppear(String elementName,
                      ImageTypeSpecifier imageType)
```
    返回true如果元素（和它下面的子树）被允许出现一元数据文档中对于给定类型的图像，通过一个定义的ImageTypeSpecifier 。例如，元数据文档格式可能包含描述图像基本颜色的元素，这在编写灰度图像时不允许。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    imageType - ImageTypeSpecifier将与元数据相关联的图像的类型的ImageTypeSpecifier。
    
    结果
    
    true如果节点对于给定类型的图像是有意义的。
  - getElementMinChildren
```
int getElementMinChildren(String elementName)
```
    返回具有子策略CHILD_POLICY_REPEAT的命名元素的最CHILD_POLICY_REPEAT 。例如，表示颜色主要信息的元素可能需要至少有3个孩子，每个小孩一个。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    结果
    
    一个 int 。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果named元素没有 CHILD_POLICY_REPEAT的子策略。
  - getElementMaxChildren
```
int getElementMaxChildren(String elementName)
```
    返回具有子策略CHILD_POLICY_REPEAT的命名元素的最大子CHILD_POLICY_REPEAT 。例如，可以允许在8位调色板中表示条目的元素重复多达256次。可以使用值Integer.MAX_VALUE来指定没有上限。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    结果
    
    一个 int 。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果named元素没有 CHILD_POLICY_REPEAT的子策略。
  - getElementDescription
```
String getElementDescription(String elementName,
                             Locale locale)
```
    返回一个String含有指定元素，或的描述null 。如果可能，说明将被本地化为提供的Locale 。
    如果locale是null ，则将使用由Locale.getLocale返回的当前默认值Locale 。
    
    参数
    
    elementName - 元素的名称。
    
    locale - 将 Locale的Locale。
    
    结果
    
    元素描述。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null ，或不是此格式的合法元素名称。
  - getChildPolicy
```
int getChildPolicy(String elementName)
```
    返回以CHILD_POLICY_开头的 CHILD_POLICY_ ，指示命名元素的子句的合法模式。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    结果
    
    其中一个 CHILD_POLICY_*常量。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
  - getChildNames
```
String[] getChildNames(String elementName)
```
    返回一个String s的数组， String允许作为命名元素的子元素的元素的名称，按照它们应该出现的顺序。如果该元素不能有子元素，则返回null 。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    结果
    
    一个数组为 String s，或为null。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
  - getAttributeNames
```
String[] getAttributeNames(String elementName)
```
    返回一个 String的数组，列出可能与命名元素相关联的属性的名称。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    结果
    
    一组 String s。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
  - getAttributeValueType
```
int getAttributeValueType(String elementName,
                          String attrName)
```
    返回以VALUE_开头的 VALUE_ ，指示指定元素中给定属性的值是否是任意的，被限制在指定范围内，被限制为一组枚举值之一，或是空格分隔的列表的任意值。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    attrName - 要查询的属性的名称。
    
    结果
    
    其中一个 VALUE_*常量。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果 attrName是 null或不是此元素的合法属性名称。
  - getAttributeDataType
```
int getAttributeDataType(String elementName,
                         String attrName)
```
    返回以DATATYPE_开头的DATATYPE_ ，表示指定元素中给定属性的值的格式和解释。如果getAttributeValueType返回VALUE_LIST ，则合法值是返回数据类型的值的空白列表。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    attrName - 要查询的属性的名称。
    
    结果
    
    其中一个 DATATYPE_*常量。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的法定元素名称。
    
    IllegalArgumentException - 如果 attrName是 null或不是此元素的合法属性名称。
  - isAttributeRequired
```
boolean isAttributeRequired(String elementName,
                            String attrName)
```
    如果命名的属性必须存在于命名的元素中，则返回 true 。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    attrName - 要查询的属性的名称。
    
    结果
    
    true如果属性必须存在。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果 attrName是 null或不是此元素的合法属性名称。
  - getAttributeDefaultValue
```
String getAttributeDefaultValue(String elementName,
                                String attrName)
```
    返回指定属性的默认值，如果没有明确指定元素中存在，为 String ，或 null如果没有默认值是可用的。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    attrName - 要查询的属性的名称。
    
    结果
    
    一个 String包含默认值，或 null 。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果 attrName是 null或不是此元素的合法属性名称。
  - getAttributeEnumerations
```
String[] getAttributeEnumerations(String elementName,
                                  String attrName)
```
    返回一个包含指定元素中给定属性的合法枚举值的数组String 。只有当getAttributeValueType返回VALUE_ENUMERATION时，才应该调用此方法。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    attrName - 要查询的属性的名称。
    
    结果
    
    一个 String的数组。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的法定元素名称。
    
    IllegalArgumentException - 如果 attrName是 null或不是此元素的合法属性名称。
    
    IllegalArgumentException - 如果给定属性未定义为枚举。
  - getAttributeMinValue
```
String getAttributeMinValue(String elementName,
                            String attrName)
```
    返回属性的最小合法值。该值是否包含或排除可以由getAttributeValueType的值getAttributeValueType 。该值返回为String ; 其解释是依赖于价值getAttributeDataType 。只有getAttributeValueType返回VALUE_RANGE_*时才应该调用此方法。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    attrName - 要查询的属性的名称。
    
    结果
    
    一个 String包含该属性的最小合法值。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果 attrName是 null或不是此元素的合法属性名称。
    
    IllegalArgumentException - 如果给定属性未定义为范围。
  - getAttributeMaxValue
```
String getAttributeMaxValue(String elementName,
                            String attrName)
```
    返回属性的最大合法值。该值是否包含或排除可以由getAttributeValueType的值getAttributeValueType 。该值返回为String ; 其解释是依赖于价值getAttributeDataType 。只有当getAttributeValueType返回VALUE_RANGE_*时，才应该调用此方法。
    
    参数
    
    elementName - 要查询的元素的名称，作为 String 。
    
    attrName - 要查询的属性的名称。
    
    结果
    
    一个 String包含该属性的最大合法值。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的法定元素名称。
    
    IllegalArgumentException - 如果 attrName是 null或不是此元素的合法属性名称。
    
    IllegalArgumentException - 如果给定属性未定义为范围。
  - getAttributeListMinLength
```
int getAttributeListMinLength(String elementName,
                              String attrName)
```
    返回可用于定义此属性的列表项的最小数量。该属性本身被定义为String包含多个空格分开的项目。只有当getAttributeValueType返回VALUE_LIST时，才应该调用此方法。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    attrName - 要查询的属性的名称。
    
    结果
    
    属性的列表项的最小合法数量。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果 attrName是 null或不是此元素的合法属性名称。
    
    IllegalArgumentException - 如果给定属性未定义为列表。
  - getAttributeListMaxLength
```
int getAttributeListMaxLength(String elementName,
                              String attrName)
```
    返回可用于定义此属性的列表项的最大数量。可以使用Integer.MAX_VALUE的值来指定没有上限。该属性本身被定义为String包含多个空格分开的项目。只有当getAttributeValueType返回VALUE_LIST时，才应该调用此方法。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    attrName - 要查询的属性的名称。
    
    结果
    
    属性的列表项的最大合法数量。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果 attrName是 null或不是此元素的合法属性名称。
    
    IllegalArgumentException - 如果给定的属性未被定义为列表。
  - getAttributeDescription
```
String getAttributeDescription(String elementName,
                               String attrName,
                               Locale locale)
```
    返回一个String该命名属性的描述的String，或null 。如果可能，说明将被本地化提供的Locale 。
    如果locale是null ，则将使用由Locale.getLocale返回的当前默认值Locale 。
    
    参数
    
    elementName - 元素的名称。
    
    attrName - 属性的名称。
    
    locale - 将 Locale的Locale。
    
    结果
    
    属性描述。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null ，或者不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果 attrName是 null或不是此元素的合法属性名称。
  - getObjectValueType
```
int getObjectValueType(String elementName)
```
    返回以所列举的值中的一个VALUE_ ，指示所允许的值（枚举，范围或阵列）的种类Object参考。如果给定元素中没有存储对象值，则该方法的结果将为VALUE_NONE 。
    Object其法定值定义为范围的Comparable必须实现Comparable接口。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    结果
    
    其中一个 VALUE_*常数。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    另请参见：
    
    Comparable
  - getObjectClass
```
类<?> getObjectClass(String elementName)
```
    返回存储在元素中的Object参考的类类型。如果此元素可能不包含Object引用，则将抛出IllegalArgumentException 。如果类类型是数组，则此字段指示底层类型（例如，对于int的数组，此方法将返回int.class ）。
    Object引用的法定值定义为范围必须实现Comparable接口。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    结果
    
    一个 类对象。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果指定的元素不能包含对象值（即 getObjectValueType(elementName) == VALUE_NONE ）。
  - getObjectDefaultValue
```
Object getObjectDefaultValue(String elementName)
```
    返回一个 Object命名元素中Object引用的默认值的 Object 。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    结果
    
    一个 Object 。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果指定的元素不能包含对象值（即 getObjectValueType(elementName) == VALUE_NONE ）。
  - getObjectEnumerations
```
Object[] getObjectEnumerations(String elementName)
```
    返回一个包含指定元素中Object引用的合法枚举值的数组，其数量为Object 。只有当getObjectValueType返回VALUE_ENUMERATION时，才应该调用此方法。
    的Object与接受枚举值必须等于由该方法返回的值中的一个，如由所定义的节点相关联==操作者（相对于所述Object.equals方法）。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    结果
    
    一个 Object的数组。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的法定元素名称。
    
    IllegalArgumentException - 如果指定的元素不能包含对象值（即 getObjectValueType(elementName) == VALUE_NONE ）。
    
    IllegalArgumentException - 如果 Object未定义为枚举。
  - getObjectMinValue
```
Comparable<?> getObjectMinValue(String elementName)
```
    返回指定元素中Object引用的最小合法值。该值是否包含或排除可以由getObjectValueType的值getObjectValueType 。只有当getObjectValueType返回以VALUE_RANGE开头的VALUE_RANGE之一时，才应该调用此方法。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    结果
    
    该属性的最小合法值。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果命名的元素不能包含对象值（即，如果 getObjectValueType(elementName) == VALUE_NONE ）。
    
    IllegalArgumentException - 如果 Object未定义为范围。
  - getObjectMaxValue
```
Comparable<?> getObjectMaxValue(String elementName)
```
    返回指定元素中Object引用的最大合法值。该值是否包含或排除可以由getObjectValueType的值getObjectValueType 。只有当getObjectValueType返回以VALUE_RANGE开头的VALUE_RANGE之一时，才应该调用此方法。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    结果
    
    该属性的最小合法值。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果指定的元素不能包含对象值（即，如果 getObjectValueType(elementName) == VALUE_NONE ）。
    
    IllegalArgumentException - 如果 Object未定义为范围。
  - getObjectArrayMinLength
```
int getObjectArrayMinLength(String elementName)
```
    返回可用于定义指定元素中Object引用的最小数组元素数。只有当getObjectValueType返回VALUE_LIST时，才应该调用此方法。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    结果
    
    Object引用的最小有效数组长度。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果指定的元素不能包含对象值（即 getObjectValueType(elementName) == VALUE_NONE ）。
    
    IllegalArgumentException - 如果 Object不是数组。
  - getObjectArrayMaxLength
```
int getObjectArrayMaxLength(String elementName)
```
    返回可用于定义指定元素中Object引用的最大数组元素数。可以使用值Integer.MAX_VALUE来指定没有上限。只有当getObjectValueType返回VALUE_LIST时，才应该调用此方法。
    
    参数
    
    elementName - 要查询的元素的名称。
    
    结果
    
    Object参考的最大有效数组长度。
    
    异常
    
    IllegalArgumentException - 如果 elementName是 null或不是此格式的合法元素名称。
    
    IllegalArgumentException - 如果命名的元素不能包含对象值（即，如果 getObjectValueType(elementName) == VALUE_NONE ）。
    
    IllegalArgumentException - 如果 Object不是数组。

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Interface IIOMetadataFormat

Field Summary

方法摘要

字段详细信息

CHILD_POLICY_EMPTY

CHILD_POLICY_ALL

CHILD_POLICY_SOME

CHILD_POLICY_CHOICE

CHILD_POLICY_SEQUENCE

CHILD_POLICY_REPEAT

CHILD_POLICY_MAX

VALUE_NONE

VALUE_ARBITRARY

VALUE_RANGE

VALUE_RANGE_MIN_INCLUSIVE_MASK

VALUE_RANGE_MAX_INCLUSIVE_MASK

VALUE_RANGE_MIN_INCLUSIVE

VALUE_RANGE_MAX_INCLUSIVE

VALUE_RANGE_MIN_MAX_INCLUSIVE

VALUE_ENUMERATION

VALUE_LIST

DATATYPE_STRING

DATATYPE_BOOLEAN

DATATYPE_INTEGER

DATATYPE_FLOAT

DATATYPE_DOUBLE

方法详细信息

getRootName

canNodeAppear

getElementMinChildren

getElementMaxChildren

getElementDescription

getChildPolicy

getChildNames

getAttributeNames

getAttributeValueType

getAttributeDataType

isAttributeRequired

getAttributeDefaultValue

getAttributeEnumerations

getAttributeMinValue

getAttributeMaxValue

getAttributeListMinLength

getAttributeListMaxLength

getAttributeDescription

getObjectValueType

getObjectClass

getObjectDefaultValue

getObjectEnumerations

getObjectMinValue

getObjectMaxValue

getObjectArrayMinLength

getObjectArrayMaxLength