- 所有已实现的接口:
-
IIOMetadataFormat
IIOMetadataFormat接口的可重用实现。此外,getStandardFormatInstance方法提供了一个表示标准的、插件中立的javax_imageio_1.0格式的静态实例。
为了提供元素和属性的本地化描述,应通过ResourceBundle.getBundle的通常机制提供一个基本名称为this.getClass().getName() + "Resources"的ResourceBundle。简而言之,子类根据命名约定(默认情况下,是扩展IIMetadataFormatImpl的子类的完全限定名称,加上字符串"Resources",再加上由下划线分隔的国家、语言和变体代码)提供一个或多个额外的类。在运行时,对getElementDescription或getAttributeDescription的调用将根据提供的区域设置动态加载这些类,并将使用元素名称或元素名称后跟'/'字符后跟属性名称作为键。此键将提供给ResourceBundle的getString方法,返回节点或属性的本地化描述。
子类可以使用setResourceBaseName方法为资源包提供不同的基本名称。
如果需要,子类可以通过覆盖getElementDescription和getAttributeDescription的提供实现来选择自己的本地化机制。
- 参见:
-
Field Summary
FieldsFields declared in interface 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 -
Constructor Summary
ConstructorsConstructorDescriptionIIOMetadataFormatImpl(String rootName, int childPolicy) 构造一个空白的IIOMetadataFormatImpl实例,具有给定的根元素名称和子策略(而非CHILD_POLICY_REPEAT)。IIOMetadataFormatImpl(String rootName, int minChildren, int maxChildren) 构造一个空白的IIOMetadataFormatImpl实例,具有给定的根元素名称和子策略CHILD_POLICY_REPEAT。 -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddAttribute(String elementName, String attrName, int dataType, boolean required, int listMinLength, int listMaxLength) 向先前定义的元素添加一个将由值列表定义的新属性。protected voidaddAttribute(String elementName, String attrName, int dataType, boolean required, String defaultValue) 向先前定义的元素添加一个可以设置为任意值的新属性。protected voidaddAttribute(String elementName, String attrName, int dataType, boolean required, String defaultValue, String minValue, String maxValue, boolean minInclusive, boolean maxInclusive) 向先前定义的元素添加一个将由值范围定义的新属性。protected voidaddAttribute(String elementName, String attrName, int dataType, boolean required, String defaultValue, List<String> enumeratedValues) 向先前定义的元素添加一个将由枚举值集合定义的新属性。protected voidaddBooleanAttribute(String elementName, String attrName, boolean hasDefaultValue, boolean defaultValue) 向先前定义的元素添加一个将由枚举值TRUE和FALSE定义的新属性,数据类型为DATATYPE_BOOLEAN。protected voidaddChildElement(String elementName, String parentName) 将现有元素添加到给定父节点类型的合法子节点列表中。protected voidaddElement(String elementName, String parentName, int childPolicy) 使用除CHILD_POLICY_REPEAT之外的子策略向此元数据文档格式添加新的元素类型。protected voidaddElement(String elementName, String parentName, int minChildren, int maxChildren) 使用CHILD_POLICY_REPEAT子策略向此元数据文档格式添加新的元素类型。protected voidaddObjectValue(String elementName, Class<?> classType, int arrayMinLength, int arrayMaxLength) 允许将给定类类型的Object引用存储在实现命名元素的节点中。protected <T> voidaddObjectValue(String elementName, Class<T> classType, boolean required, T defaultValue) 允许将给定类类型的Object引用存储在实现命名元素的节点中。protected <T> voidaddObjectValue(String elementName, Class<T> classType, boolean required, T defaultValue, List<? extends T> enumeratedValues) 允许将给定类类型的Object引用存储在实现命名元素的节点中。protected <T extends Object & Comparable<? super T>>
voidaddObjectValue(String elementName, Class<T> classType, T defaultValue, Comparable<? super T> minValue, Comparable<? super T> maxValue, boolean minInclusive, boolean maxInclusive) 允许将给定类类型的Object引用存储在实现命名元素的节点中。intgetAttributeDataType(String elementName, String attrName) 返回以DATATYPE_开头的常量之一,指示给定属性值的格式和解释在命名元素内。getAttributeDefaultValue(String elementName, String attrName) 如果在命名元素内未明确设置命名属性的默认值,则返回命名属性的默认值作为String,如果没有默认值可用,则返回null。getAttributeDescription(String elementName, String attrName, Locale locale) 返回包含命名属性描述的String,或null。String[]getAttributeEnumerations(String elementName, String attrName) 返回一个String数组,其中包含给定属性在命名元素内的合法枚举值。intgetAttributeListMaxLength(String elementName, String attrName) 返回可用于定义此属性的列表项的最大数量。intgetAttributeListMinLength(String elementName, String attrName) 返回可用于定义此属性的列表项的最小数量。getAttributeMaxValue(String elementName, String attrName) 返回属性的最大合法值。getAttributeMinValue(String elementName, String attrName) 返回属性的最小合法值。String[]getAttributeNames(String elementName) 返回一个String数组,列出可以与命名元素关联的属性的名称。intgetAttributeValueType(String elementName, String attrName) 返回以VALUE_开头的常量之一,指示命名元素内给定属性的值的类型(枚举、范围或数组)。String[]getChildNames(String elementName) 返回一个String数组,指示允许作为命名元素的子节点的元素的名称,以应出现的顺序。intgetChildPolicy(String elementName) 返回以CHILD_POLICY_开头的常量之一,指示命名元素的子节点的合法模式。getElementDescription(String elementName, Locale locale) 返回包含命名元素描述的String,或null。intgetElementMaxChildren(String elementName) 返回具有子策略CHILD_POLICY_REPEAT的命名元素的最大子节点数。intgetElementMinChildren(String elementName) 返回具有子策略CHILD_POLICY_REPEAT的命名元素的最小子节点数。intgetObjectArrayMaxLength(String elementName) 返回可用于定义命名元素内Object引用的数组元素的最大数量。intgetObjectArrayMinLength(String elementName) 返回可用于定义命名元素内Object引用的数组元素的最小数量。Class<?> getObjectClass(String elementName) 返回存储在元素内的Object引用的Class类型。getObjectDefaultValue(String elementName) 返回命名元素内Object引用的默认值的Object。Object[]getObjectEnumerations(String elementName) 返回一个Object数组,其中包含命名元素内Object引用的合法枚举值。Comparable<?> getObjectMaxValue(String elementName) 返回Object引用内的最大合法值。Comparable<?> getObjectMinValue(String elementName) 返回Object引用内的最小合法值。intgetObjectValueType(String elementName) 返回以VALUE_开头的枚举值之一,指示允许用于Object引用的值类型(枚举、范围或数组)。protected String返回用于定位ResourceBundle的当前设置的基本名称。返回格式的根元素名称。static IIOMetadataFormat返回描述在javax.imageio.metadata包的注释中描述的标准、插件中立的javax_imageio_1.0元数据文档格式的IIOMetadataFormat对象。booleanisAttributeRequired(String elementName, String attrName) 如果命名元素内必须存在命名属性,则返回true。protected voidremoveAttribute(String elementName, String attrName) 从先前定义的元素中移除一个属性。protected voidremoveElement(String elementName) 从格式中移除一个元素。protected voidremoveObjectValue(String elementName) 禁止将Object引用存储在实现命名元素的节点中。protected voidsetResourceBaseName(String resourceBaseName) 为此格式包含元素和属性描述的ResourceBundle设置新的基本名称。Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods declared in interface javax.imageio.metadata.IIOMetadataFormat
canNodeAppear
-
Field Details
-
standardMetadataFormatName
包含标准格式名称"javax_imageio_1.0"的String常量。- 参见:
-
-
Constructor Details
-
IIOMetadataFormatImpl
构造一个空白的IIOMetadataFormatImpl实例,具有给定的根元素名称和子策略(而非CHILD_POLICY_REPEAT)。可以使用各种add方法添加其他元素、它们的属性和Object引用信息。- 参数:
-
rootName- 根元素的名称。 -
childPolicy-CHILD_POLICY_*常量之一,而非CHILD_POLICY_REPEAT。 - 抛出:
-
IllegalArgumentException- 如果rootName为null。 -
IllegalArgumentException- 如果childPolicy不是预定义常量之一。
-
IIOMetadataFormatImpl
构造一个空白的IIOMetadataFormatImpl实例,具有给定的根元素名称和CHILD_POLICY_REPEAT子策略。可以使用各种add方法添加其他元素、它们的属性和Object引用信息。- 参数:
-
rootName- 根元素的名称。 -
minChildren- 节点的最小子节点数。 -
maxChildren- 节点的最大子节点数。 - 抛出:
-
IllegalArgumentException- 如果rootName为null。 -
IllegalArgumentException- 如果minChildren为负数或大于maxChildren。
-
-
Method Details
-
setResourceBaseName
设置用于包含此格式的元素和属性描述的ResourceBundle的新基本名称。在第一次调用此方法之前,基本名称将等于
this.getClass().getName() + "Resources"。- 参数:
-
resourceBaseName- 包含新基本名称的String。 - 抛出:
-
IllegalArgumentException- 如果resourceBaseName为null。 - 参见:
-
getResourceBaseName
返回当前设置的用于定位ResourceBundle的基本名称。- 返回:
-
包含基本名称的
String。 - 参见:
-
addElement
向此元数据文档格式添加一个具有不同于CHILD_POLICY_REPEAT的子策略的新元素类型。- 参数:
-
elementName- 新元素的名称。 -
parentName- 将成为新元素父级的元素的名称。 -
childPolicy-CHILD_POLICY_*常量之一,除了CHILD_POLICY_REPEAT,表示新元素的子策略。 - 抛出:
-
IllegalArgumentException- 如果parentName为null,或者不是此格式的合法元素名称。 -
IllegalArgumentException- 如果childPolicy不是预定义常量之一。
-
addElement
向此元数据文档格式添加一个具有CHILD_POLICY_REPEAT子策略的新元素类型。- 参数:
-
elementName- 新元素的名称。 -
parentName- 将成为新元素父级的元素的名称。 -
minChildren- 节点的最小子级数。 -
maxChildren- 节点的最大子级数。 - 抛出:
-
IllegalArgumentException- 如果parentName为null,或者不是此格式的合法元素名称。 -
IllegalArgumentException- 如果minChildren为负数或大于maxChildren。
-
addChildElement
将现有元素添加到给定父节点类型的合法子级列表中。- 参数:
-
elementName- 要添加为子级的元素的名称。 -
parentName- 将成为元素新父级的元素的名称。 - 抛出:
-
IllegalArgumentException- 如果elementName为null,或者不是此格式的合法元素名称。 -
IllegalArgumentException- 如果parentName为null,或者不是此格式的合法元素名称。
-
removeElement
从格式中删除一个元素。如果没有具有给定名称的元素存在,则不会发生任何操作,也不会抛出异常。- 参数:
-
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- 包含属性的合法值的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- 如果minValue是包含的,则为true。 -
maxInclusive- 如果maxValue是包含的,则为true。 - 抛出:
-
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
从先前定义的元素中删除属性。如果给定元素中没有具有给定名称的属性,则不会发生任何操作,也不会抛出异常。- 参数:
-
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。 - 抛出:
-
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-Object引用的默认值。 -
minValue- 对象值的最小(根据minInclusive的值是包含还是不包含)合法值,作为String。 -
maxValue- 对象值的最大(根据minInclusive的值是包含还是不包含)合法值,作为String。 -
minInclusive- 如果minValue是包含的,则为true。 -
maxInclusive- 如果maxValue是包含的,则为true。 - 抛出:
-
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
禁止存储Object引用在实现命名元素的节点中。- 参数:
-
elementName- 元素的名称。 - 抛出:
-
IllegalArgumentException- 如果elementName不是此格式的合法元素名称。
-
getRootName
从接口复制的描述:IIOMetadataFormat返回格式的根元素的名称。- 指定者:
-
getRootName在接口IIOMetadataFormat - 返回:
-
一个
String。
-
getElementMinChildren
从接口复制的描述:IIOMetadataFormat返回具有子策略CHILD_POLICY_REPEAT的命名元素的最小子元素数。例如,表示颜色主要信息的元素可能需要至少有3个子元素,每个主要颜色一个。- 指定者:
-
getElementMinChildren在接口IIOMetadataFormat - 参数:
-
elementName- 正在查询的元素的名称。 - 返回:
-
一个
int。
-
getElementMaxChildren
从接口复制的描述:IIOMetadataFormat返回具有子策略CHILD_POLICY_REPEAT的命名元素的最大子元素数。例如,表示8位颜色调色板中的条目的元素可能允许重复最多256次。可以使用Integer.MAX_VALUE来指定没有上限。- 指定者:
-
getElementMaxChildren在接口IIOMetadataFormat - 参数:
-
elementName- 正在查询的元素的名称。 - 返回:
-
一个
int。
-
getElementDescription
返回一个包含命名元素描述的String,或null。如果可能,描述将针对提供的Locale进行本地化。默认实现将首先使用由
setResourceBaseName设置的当前资源基本名称和提供的Locale来定位ResourceBundle,使用ResourceBundle.getBundle的注释中描述的回退机制。如果找到ResourceBundle,则元素名称将用作其getString方法的键,并返回结果。如果找不到ResourceBundle,或者没有这样的键存在,则将返回null。如果
locale为null,则将使用由Locale.getLocale返回的当前默认Locale。- 指定者:
-
getElementDescription在接口IIOMetadataFormat中 - 参数:
-
elementName- 元素的名称。 -
locale- 尝试本地化的Locale。 - 返回值:
- 元素描述。
- 抛出:
-
IllegalArgumentException- 如果elementName为null,或者不是此格式的合法元素名称。 - 参见:
-
getChildPolicy
从接口复制的描述:IIOMetadataFormat返回以CHILD_POLICY_开头的常量之一,指示命名元素的子元素的合法模式。- 指定者:
-
getChildPolicy在接口IIOMetadataFormat中 - 参数:
-
elementName- 正在查询的元素的名称。 - 返回值:
-
CHILD_POLICY_*常量之一。
-
getChildNames
从接口复制的描述:IIOMetadataFormat返回一个String数组,指示允许作为命名元素子元素的元素名称,按照它们应该出现的顺序。如果元素不能有子元素,则返回null。- 指定者:
-
getChildNames在接口IIOMetadataFormat中 - 参数:
-
elementName- 正在查询的元素的名称。 - 返回值:
-
一个
String数组,或者为null。
-
getAttributeNames
从接口复制的描述:IIOMetadataFormat返回一个String数组,列出可以与命名元素关联的属性的名称。- 指定者:
-
getAttributeNames在接口IIOMetadataFormat中 - 参数:
-
elementName- 正在查询的元素的名称。 - 返回值:
-
一个
String数组。
-
getAttributeValueType
从接口复制的描述:IIOMetadataFormat返回以VALUE_开头的常量之一,指示命名元素中给定属性的值是任意的,受限于指定范围内,受限于一组枚举值之一,或者是一组任意值的空格分隔列表。- 指定者:
-
getAttributeValueType在接口IIOMetadataFormat中 - 参数:
-
elementName- 正在查询的元素的名称。 -
attrName- 正在查询的属性的名称。 - 返回值:
-
VALUE_*常量之一。
-
getAttributeDataType
从接口复制的描述:IIOMetadataFormat返回以DATATYPE_开头的常量之一,指示命名元素中给定属性的值的格式和解释。如果getAttributeValueType返回VALUE_LIST,则合法值是返回的数据类型的一组空格分隔值。- 指定者:
-
getAttributeDataType在接口IIOMetadataFormat中 - 参数:
-
elementName- 正在查询的元素的名称。 -
attrName- 正在查询的属性的名称。 - 返回值:
-
DATATYPE_*常量之一。
-
isAttributeRequired
从接口复制的描述:IIOMetadataFormat如果命名属性必须存在于命名元素中,则返回true。- 指定者:
-
isAttributeRequired在接口IIOMetadataFormat中 - 参数:
-
elementName- 正在查询的元素的名称。 -
attrName- 正在查询的属性的名称。 - 返回值:
-
如果属性必须存在,则返回
true。
-
getAttributeDefaultValue
从接口复制的描述:IIOMetadataFormat返回命名属性的默认值,如果它在命名元素中没有明确存在,则返回一个String,如果没有默认值可用,则返回null。- 指定者:
-
getAttributeDefaultValue在接口IIOMetadataFormat中 - 参数:
-
elementName- 正在查询的元素的名称。 -
attrName- 正在查询的属性的名称。 - 返回值:
-
包含默认值的
String,或者null。
-
getAttributeEnumerations
从接口复制的描述:IIOMetadataFormat返回一个String数组,其中包含命名元素中给定属性的合法枚举值。只有在getAttributeValueType返回VALUE_ENUMERATION时才应调用此方法。- 指定者:
-
getAttributeEnumerations在接口IIOMetadataFormat中 - 参数:
-
elementName- 正在查询的元素的名称。 -
attrName- 正在查询的属性的名称。 - 返回值:
-
一个
String数组。
-
getAttributeMinValue
从接口复制的描述:IIOMetadataFormat返回属性的最小合法值。这个值是包含的还是排除的可能由getAttributeValueType的值确定。该值以String形式返回;其解释取决于getAttributeDataType的值。只有在getAttributeValueType返回VALUE_RANGE_*时才应调用此方法。- 指定者:
-
getAttributeMinValue在接口IIOMetadataFormat中 - 参数:
-
elementName- 正在查询的元素的名称。 -
attrName- 正在查询的属性的名称。 - 返回值:
-
包含属性的最小合法值的
String。
-
getAttributeMaxValue
从接口复制的描述:IIOMetadataFormat返回属性的最大合法值。这个值是包含的还是排除的可能由getAttributeValueType的值确定。该值以String形式返回;其解释取决于getAttributeDataType的值。只有在getAttributeValueType返回VALUE_RANGE_*时才应调用此方法。- 指定者:
-
getAttributeMaxValue在接口IIOMetadataFormat中 - 参数:
-
elementName- 被查询元素的名称,作为一个String。 -
attrName- 被查询属性的名称。 - 返回值:
-
包含属性的最大合法值的
String。
-
getAttributeListMinLength
从接口中复制的描述:IIOMetadataFormat返回可用于定义此属性的最小列表项数。属性本身被定义为包含多个以空格分隔的项的String。只有在getAttributeValueType返回VALUE_LIST时才应调用此方法。- 指定者:
-
getAttributeListMinLength在接口IIOMetadataFormat中 - 参数:
-
elementName- 被查询元素的名称。 -
attrName- 被查询属性的名称。 - 返回值:
- 属性的最小合法列表项数。
-
getAttributeListMaxLength
从接口中复制的描述:IIOMetadataFormat返回可用于定义此属性的最大列表项数。可以使用Integer.MAX_VALUE来指定没有上限。属性本身被定义为包含多个以空格分隔的项的String。只有在getAttributeValueType返回VALUE_LIST时才应调用此方法。- 指定者:
-
getAttributeListMaxLength在接口IIOMetadataFormat中 - 参数:
-
elementName- 被查询元素的名称。 -
attrName- 被查询属性的名称。 - 返回值:
- 属性的最大合法列表项数。
-
getAttributeDescription
返回包含命名属性描述的String,或null。如果可能,描述将针对提供的Locale进行本地化。默认实现将首先使用由
setResourceBaseName设置的当前资源基本名称和提供的Locale来定位ResourceBundle,使用ResourceBundle.getBundle的注释中描述的回退机制。如果找到ResourceBundle,将使用元素名称后跟一个"/"字符后跟属性名称(elementName + "/" + attrName)作为其getString方法的键,并返回结果。如果未找到ResourceBundle,或者没有此键存在,则将返回null。如果
locale为null,将使用由Locale.getLocale返回的当前默认Locale。- 指定者:
-
getAttributeDescription在接口IIOMetadataFormat中 - 参数:
-
elementName- 元素的名称。 -
attrName- 属性的名称。 -
locale- 将尝试本地化的Locale,或null。 - 返回值:
- 属性描述。
- 抛出:
-
IllegalArgumentException- 如果elementName为null,或者不是此格式的合法元素名称。 -
IllegalArgumentException- 如果attrName为null或者不是此元素的合法属性名称。 - 参见:
-
getObjectValueType
从接口中复制的描述:IIOMetadataFormat返回以VALUE_开头的枚举值之一,指示允许用于Object引用的值类型(枚举、范围或数组)。如果给定元素内无法存储对象值,则此方法的结果将是VALUE_NONE。其合法值被定义为范围的
Object引用必须实现Comparable接口。- 指定者:
-
getObjectValueType在接口IIOMetadataFormat中 - 参数:
-
elementName- 被查询元素的名称。 - 返回值:
-
VALUE_*常量之一。 - 参见:
-
getObjectClass
从接口中复制的描述:IIOMetadataFormat返回存储在元素内的Object引用的Class类型。如果此元素可能不包含Object引用,则将抛出IllegalArgumentException。如果类类型是数组,则此字段指示基础类类型(例如,对于int数组,此方法将返回int.class)。其合法值被定义为范围的
Object引用必须实现Comparable接口。- 指定者:
-
getObjectClass在接口IIOMetadataFormat中 - 参数:
-
elementName- 被查询元素的名称。 - 返回值:
-
一个
Class对象。
-
getObjectDefaultValue
从接口中复制的描述:IIOMetadataFormat返回包含命名元素内Object引用的默认值的Objects。- 指定者:
-
getObjectDefaultValue在接口IIOMetadataFormat中 - 参数:
-
elementName- 被查询元素的名称。 - 返回值:
-
一个
Object。
-
getObjectEnumerations
从接口中复制的描述:IIOMetadataFormat返回包含命名元素内Object引用的合法枚举值的Object数组。只有在getObjectValueType返回VALUE_ENUMERATION时才应调用此方法。接受枚举值的节点关联的
Object必须等于此方法返回的值之一,由==运算符定义(而不是Object.equals方法)。- 指定者:
-
getObjectEnumerations在接口IIOMetadataFormat中 - 参数:
-
elementName- 被查询元素的名称。 - 返回值:
-
一个
Object数组。
-
getObjectMinValue
从接口中复制的描述:IIOMetadataFormat返回命名元素内Object引用的最小合法值。此值是包含或不包含的取决于getObjectValueType的值。只有在getObjectValueType返回以VALUE_RANGE开头的常量之一时才应调用此方法。- 指定者:
-
getObjectMinValue在接口IIOMetadataFormat中 - 参数:
-
elementName- 被查询元素的名称。 - 返回值:
- 属性的最小合法值。
-
getObjectMaxValue
从接口中复制的描述:IIOMetadataFormat返回指定元素内Object引用的最大合法值。该值是包含的还是排除的取决于getObjectValueType的值。只有当getObjectValueType返回以VALUE_RANGE开头的常量之一时,才应调用此方法。- 指定者:
-
getObjectMaxValue在接口IIOMetadataFormat - 参数:
-
elementName- 正在查询的元素的名称。 - 返回:
- 属性的最小合法值。
-
getObjectArrayMinLength
从接口复制的描述:IIOMetadataFormat返回用于定义指定元素内Object引用的数组元素的最小数量。只有当getObjectValueType返回VALUE_LIST时,才应调用此方法。- 指定者:
-
getObjectArrayMinLength在接口IIOMetadataFormat - 参数:
-
elementName- 正在查询的元素的名称。 - 返回:
-
Object引用的最小有效数组长度。
-
getObjectArrayMaxLength
从接口复制的描述:IIOMetadataFormat返回用于定义指定元素内Object引用的数组元素的最大数量。可以使用Integer.MAX_VALUE来指定没有上限。只有当getObjectValueType返回VALUE_LIST时,才应调用此方法。- 指定者:
-
getObjectArrayMaxLength在接口IIOMetadataFormat - 参数:
-
elementName- 正在查询的元素的名称。 - 返回:
-
Object引用的最大有效数组长度。
-
getStandardFormatInstance
返回描述标准、插件中立的javax.imageio_1.0元数据文档格式的IIOMetadataFormat对象,该格式在javax.imageio.metadata包的注释中描述。- 返回:
-
预定义的
IIOMetadataFormat实例。
-