JavaTM 2 Platform
Standard Ed. 6

javax.imageio.metadata
類別 IIOMetadataFormatImpl

java.lang.Object
  繼承者 javax.imageio.metadata.IIOMetadataFormatImpl
所有已實作的介面:
IIOMetadataFormat

public abstract class IIOMetadataFormatImpl
extends Object
implements IIOMetadataFormat

提供 IIOMetadataFormat 介面的可重用實作的具體類別。此外,通過 getStandardFormatInstance 方法提供一個表示標準的、外掛程式無關的 javax_imageio_1.0 格式的靜態實例。

為了提供元素和屬性的本地化的描述,應該通過 ResourceBundle.getBundle 使用的常規機制來提供基本名稱為 this.getClass().getName() + "Resources"ResourceBundle。簡單地說,子類別根據命名約定(預設情況下為擴展 IIMetadataFormatImpl 的子類別的完全限定名,加上字元串 "Resources",加上國家/地區、語言和由下劃線分隔的變體程式碼)提供一個或多個其他類別。在運行期間,調用 getElementDescriptiongetAttributeDescription 將嘗試根據提供的語言環境動態載入這些類別,並將使用元素名稱或者後跟 '/' 字元再後跟作為鍵的屬性名的元素名稱。此鍵將提供給 ResourceBundlegetString 方法,並返回所得到的節點或屬性的本地化描述。

子類別可以使用 setResourceBaseName 方法為資源包提供另外的基本名稱。

在需要時,子類別可以通過覆寫提供的 getElementDescriptiongetAttributeDescription 實作來選擇它自己的本地化機制。

另請參見:
ResourceBundle.getBundle(String,Locale)

欄位摘要
static String standardMetadataFormatName
          包含標準格式名稱 "javax_imageio_1.0"String 常數。
 
從介面 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
 
建構子摘要
IIOMetadataFormatImpl(String rootName, int childPolicy)
          建構一個空的 IIOMetadataFormatImpl 實例,使其具有給定根元素名稱和子策略(CHILD_POLICY_REPEAT 除外)。
IIOMetadataFormatImpl(String rootName, int minChildren, int maxChildren)
          建構一個空的 IIOMetadataFormatImpl 實例,使其具有給定根元素名稱和子策略 CHILD_POLICY_REPEAT
 
方法摘要
protected  void addAttribute(String elementName, String attrName, int dataType, boolean required, int listMinLength, int listMaxLength)
          將新屬性添加到以前定義的元素中,該元素將由值的列表定義。
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 addBooleanAttribute(String elementName, String attrName, boolean hasDefaultValue, boolean defaultValue)
          將新屬性添加到以前定義的元素中,該元素將由列舉值 TRUEFALSE 定義,資料型別為 DATATYPE_BOOLEAN
protected  void addChildElement(String elementName, String parentName)
          將現有元素添加到給定父節點型別的合法子節點的列表中。
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 addObjectValue(String elementName, Class<?> classType, int arrayMinLength, int arrayMaxLength)
          允許將給定類別型別的 Object 參考存儲在實作指定元素的節點中。
protected
<T> void
addObjectValue(String elementName, Class<T> classType, boolean required, T defaultValue)
          允許將給定類別型別的 Object 參考存儲在實作指定元素的節點中。
protected
<T> void
addObjectValue(String elementName, Class<T> classType, boolean required, T defaultValue, List<? extends T> enumeratedValues)
          允許將給定類別型別的 Object 參考存儲在實作指定元素的節點中。
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 參考存儲在實作指定元素的節點中。
abstract  boolean canNodeAppear(String elementName, ImageTypeSpecifier imageType)
          如果允許元素(和它下面的子階層樹)在給定型別(由 ImageTypeSpecifier 定義)的圖像的元資料文檔中出現,則返回 true
 int getAttributeDataType(String elementName, String attrName)
          返回以 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_ 開頭的常數之一,指示指定元素中給定屬性的值是任意值、被限制在指定範圍中的值、被限制為一組列舉值之一,還是一個任意值的以空白分隔的列表。
 String[] getChildNames(String elementName)
          返回一個按出現順序排列的 String 陣列,指示允許作為指定元素子元素的元素的名稱。
 int getChildPolicy(String elementName)
          返回以 CHILD_POLICY_ 開頭的常數之一,指示指定元素子元素的合法網要。
 String getElementDescription(String elementName, Locale locale)
          返回包含指定元素的描述的 String,或者 null
 int getElementMaxChildren(String elementName)
          返回使用子策略 CHILD_POLICY_REPEAT 的指定元素的最大子元素數。
 int getElementMinChildren(String elementName)
          返回使用子策略 CHILD_POLICY_REPEAT 的指定元素的最小子元素數。
 int getObjectArrayMaxLength(String elementName)
          返回指定元素中可用於定義 Object 參考的最大陣列元素數。
 int getObjectArrayMinLength(String elementName)
          返回指定元素中可用於定義 Object 參考的最小陣列元素數。
 Class<?> getObjectClass(String elementName)
          返回存儲在元素中的 Class 型別的 Object 參考。
 Object getObjectDefaultValue(String elementName)
          返回包含指定元素中 Object 參考的預設值的 Object
 Object[] getObjectEnumerations(String elementName)
          返回一個 Object 陣列,該陣列包含指定元素中 Object 參考的合法列舉值。
 Comparable<?> getObjectMaxValue(String elementName)
          返回指定元素中 Object 參考的最大合法值。
 Comparable<?> getObjectMinValue(String elementName)
          返回指定元素中 Object 參考的最小合法值。
 int getObjectValueType(String elementName)
          返回以 VALUE_ 開頭的列舉值之一,指示允許用於 Object 參考的值(列舉、範圍或陣列)的型別。
protected  String getResourceBaseName()
          返回當前設置的用於尋找 ResourceBundle 的基本名稱。
 String getRootName()
          返回格式的根元素的名稱。
static IIOMetadataFormat getStandardFormatInstance()
          返回描述標準、外掛程式無關的 javax.imageio_1.0 元資料文檔格式的 IIOMetadataFormat 物件,該文檔格式在 javax.imageio.metadata 套件的註釋中描述。
 boolean isAttributeRequired(String elementName, String attrName)
          如果指定屬性必須在指定元素中存在,則返回 true
protected  void removeAttribute(String elementName, String attrName)
          從以前定義的元素中移除屬性。
protected  void removeElement(String elementName)
          從格式中移除元素。
protected  void removeObjectValue(String elementName)
          禁止將 Object 參考存儲在實作指定元素的節點中。
protected  void setResourceBaseName(String resourceBaseName)
          設置用於尋找包含此格式的元素和屬性描述的 ResourceBundle 新基本名稱。
 
從類別 java.lang.Object 繼承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

欄位詳細資訊

standardMetadataFormatName

public static final String standardMetadataFormatName
包含標準格式名稱 "javax_imageio_1.0"String 常數。

另請參見:
常數欄位值
建構子詳細資訊

IIOMetadataFormatImpl

public IIOMetadataFormatImpl(String rootName,
                             int childPolicy)
建構一個空的 IIOMetadataFormatImpl 實例,使其具有給定根元素名稱和子策略(CHILD_POLICY_REPEAT 除外)。其他元素及其屬性以及 Object 參考資訊可以使用各種 add 方法添加。

參數:
rootName - 根元素的名稱。
childPolicy - CHILD_POLICY_REPEAT 之外的 CHILD_POLICY_* 常數之一。
拋出:
IllegalArgumentException - 如果 rootNamenull
IllegalArgumentException - 如果 childPolicy 不是預定義的常數之一。

IIOMetadataFormatImpl

public IIOMetadataFormatImpl(String rootName,
                             int minChildren,
                             int maxChildren)
建構一個空的 IIOMetadataFormatImpl 實例,使其具有給定根元素名稱和子策略 CHILD_POLICY_REPEAT。其他元素及其屬性以及 Object 參考資訊可以使用各種 add 方法添加。

參數:
rootName - 根元素的名稱。
minChildren - 節點的最小子節點數。
maxChildren - 節點的最大子節點數。
拋出:
IllegalArgumentException - 如果 rootNamenull
IllegalArgumentException - 如果 minChildren 為負或大於 maxChildren
方法詳細資訊

setResourceBaseName

protected void setResourceBaseName(String resourceBaseName)
設置用於尋找包含此格式的元素和屬性描述的 ResourceBundle 新基本名稱。

在首次調用此方法之前,基本名稱將等於 this.getClass().getName() + "Resources"

參數:
resourceBaseName - 套件含新基本名稱的 String
拋出:
IllegalArgumentException - 如果 resourceBaseNamenull
另請參見:
getResourceBaseName()

getResourceBaseName

protected String getResourceBaseName()
返回當前設置的用於尋找 ResourceBundle 的基本名稱。

返回:
包含基本名稱的 String
另請參見:
setResourceBaseName(java.lang.String)

addElement

protected void addElement(String elementName,
                          String parentName,
                          int childPolicy)
使用某個子策略(CHILD_POLICY_REPEAT 除外)將新元素型別添加到此元資料文檔格式中。

參數:
elementName - 新元素的名稱。
parentName - 將作為新元素的父元素的元素的名稱。
childPolicy - CHILD_POLICY_REPEAT 之外的 CHILD_POLICY_* 常數之一,指示新元素的子策略。
拋出:
IllegalArgumentException - 如果 parentNamenull 或者不是此格式的合法元素名稱。
IllegalArgumentException - 如果 childPolicy 不是預定義的常數之一。

addElement

protected void addElement(String elementName,
                          String parentName,
                          int minChildren,
                          int maxChildren)
使用子策略 CHILD_POLICY_REPEAT 將新元素型別添加到此元資料文檔格式中。

參數:
elementName - 新元素的名稱。
parentName - 將作為新元素的父元素的元素的名稱。
minChildren - 節點的最小子節點數。
maxChildren - 節點的最大子節點數。
拋出:
IllegalArgumentException - 如果 parentNamenull 或者不是此格式的合法元素名稱。
IllegalArgumentException - 如果 minChildren 為負或大於 maxChildren

addChildElement

protected void addChildElement(String elementName,
                               String parentName)
將現有元素添加到給定父節點型別的合法子節點的列表中。

參數:
parentName - 將作為元素的新父元素的元素的名稱。
elementName - 要作為子元素添加的元素的名稱。
拋出:
IllegalArgumentException - 如果 elementNamenull 或者不是此格式的合法元素名稱。
IllegalArgumentException - 如果 parentNamenull 或者不是此格式的合法元素名稱。

removeElement

protected void removeElement(String elementName)
從格式中移除元素。如果不存在使用給定名字的元素,則不執行任何操作並且不會拋出任何異常。

參數:
elementName - 要移除的元素的名稱。

addAttribute

protected void addAttribute(String elementName,
                            String attrName,
                            int dataType,
                            boolean required,
                            String defaultValue)
將新屬性添加到以前定義的可以被設置為任意值的元素中。

參數:
elementName - 元素的名稱。
attrName - 要添加的屬性的名稱。
dataType - 屬性的資料型別(字元串格式),DATATYPE_* 常數之一。
required - 如果屬性必須存在,則為 true
defaultValue - 屬性的預設值,或者為 null
拋出:
IllegalArgumentException - 如果 elementNamenull 或者不是此格式的合法元素名稱。
IllegalArgumentException - 如果 attrNamenull
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 組成的 List
拋出:
IllegalArgumentException - 如果 elementNamenull 或者不是此格式的合法元素名稱。
IllegalArgumentException - 如果 attrNamenull
IllegalArgumentException - 如果 dataType 不是預定義的常數之一。
IllegalArgumentException - 如果 enumeratedValuesnull
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 - 如果 elementNamenull 或者不是此格式的合法元素名稱。
IllegalArgumentException - 如果 attrNamenull
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 - 如果 elementNamenull 或者不是此格式的合法元素名稱。
IllegalArgumentException - 如果 attrNamenull
IllegalArgumentException - 如果 dataType 不是預定義的常數之一。
IllegalArgumentException - 如果 listMinLength 為負或大於 listMaxLength

addBooleanAttribute

protected void addBooleanAttribute(String elementName,
                                   String attrName,
                                   boolean hasDefaultValue,
                                   boolean defaultValue)
將新屬性添加到以前定義的元素中,該元素將由列舉值 TRUEFALSE 定義,資料型別為 DATATYPE_BOOLEAN

參數:
elementName - 元素的名稱。
attrName - 要添加的屬性的名稱。
hasDefaultValue - 如果預設值應該存在,則為 true
defaultValue - boolean 值形式的屬性預設值;如果 hasDefaultValuefalse,則忽略該參數。
拋出:
IllegalArgumentException - 如果 elementNamenull 或者不是此格式的合法元素名稱。
IllegalArgumentException - 如果 attrNamenull

removeAttribute

protected void removeAttribute(String elementName,
                               String attrName)
從以前定義的元素中移除屬性。如果在給定元素中不存在使用給定名字的屬性,則不執行任何操作並且不會拋出任何異常。

參數:
elementName - 元素的名稱。
attrName - 要移除的屬性的名稱。
拋出:
IllegalArgumentException - 如果 elementNamenull 或者不是此格式的合法元素名稱。

addObjectValue

protected <T> void addObjectValue(String elementName,
                                  Class<T> classType,
                                  boolean required,
                                  T defaultValue)
允許將給定類別型別的 Object 參考存儲在實作指定元素的節點中。Object 的值是不受約束的(其類別型別除外)。

如果以前允許 Object 參考,則覆寫以前的設置值。

參數:
elementName - 元素的名稱。
classType - 指示物件值的合法類別型別的 Class 變數。
required - 如果物件值必須存在,則為 true
defaultValue - Object 參考的預設值,或者為 null
拋出:
IllegalArgumentException - 如果 elementNamenull 或者不是此格式的合法元素名稱。

addObjectValue

protected <T> void addObjectValue(String elementName,
                                  Class<T> classType,
                                  boolean required,
                                  T defaultValue,
                                  List<? extends T> enumeratedValues)
允許將給定類別型別的 Object 參考存儲在實作指定元素的節點中。Object 的值必須為 enumeratedValues 給出的值之一。

如果以前允許 Object 參考,則覆寫以前的設置值。

參數:
elementName - 元素的名稱。
classType - 指示物件值的合法類別型別的 Class 變數。
required - 如果物件值必須存在,則為 true
defaultValue - Object 參考的預設值,或者為 null
enumeratedValues - 套件含物件參考的合法值的 Object 組成的 List
拋出:
IllegalArgumentException - 如果 elementNamenull 或者不是此格式的合法元素名稱。
IllegalArgumentException - 如果 enumeratedValuesnull
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 的值必須在 minValuemaxValue 給出的範圍中。此外,類別型別必須實作 Comparable 介面。

如果以前允許 Object 參考,則覆寫以前的設置值。

參數:
elementName - 元素的名稱。
classType - 指示物件值的合法類別型別的 Class 變數。
defaultValue - 預設值
minValue - 物件值的最小(是否包括兩端的值取決於 minInclusive 的值)合法值(String 形式)。
maxValue - 物件值的最大(是否包括兩端的值取決於 minInclusive 的值)合法值(String 形式)。
minInclusive - 如果包括 minValue,則為 true
maxInclusive - 如果包括 maxValue,則為 true
拋出:
IllegalArgumentException - 如果 elementNamenull 或者不是此格式的合法元素名稱。

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

protected void removeObjectValue(String elementName)
禁止將 Object 參考存儲在實作指定元素的節點中。

參數:
elementName - 元素的名稱。
拋出:
IllegalArgumentException - 如果 elementName 不是此格式的合法元素名稱。

getRootName

public String getRootName()
從介面 IIOMetadataFormat 複製的描述
返回格式的根元素的名稱。

指定者:
介面 IIOMetadataFormat 中的 getRootName
返回:
String

canNodeAppear

public abstract boolean canNodeAppear(String elementName,
                                      ImageTypeSpecifier imageType)
從介面 IIOMetadataFormat 複製的描述
如果允許元素(和它下面的子階層樹)在給定型別(由 ImageTypeSpecifier 定義)的圖像的元資料文檔中出現,則返回 true。例如,元資料文檔格式可能包含描述圖像原色的元素,該元素在寫入灰度級圖像時是不允許出現的。

指定者:
介面 IIOMetadataFormat 中的 canNodeAppear
參數:
elementName - 要查詢的元素的名稱。
imageType - 指示將與元資料關聯的圖像型別的 ImageTypeSpecifier
返回:
如果節點對於給定型別的圖像有意義,則返回 true

getElementMinChildren

public int getElementMinChildren(String elementName)
從介面 IIOMetadataFormat 複製的描述
返回使用子策略 CHILD_POLICY_REPEAT 的指定元素的最小子元素數。例如,表示原色資訊的元素可能需要具有至少 3 個子元素,每種原色一個子元素。

指定者:
介面 IIOMetadataFormat 中的 getElementMinChildren
參數:
elementName - 要查詢的元素的名稱。
返回:
int

getElementMaxChildren

public int getElementMaxChildren(String elementName)
從介面 IIOMetadataFormat 複製的描述
返回使用子策略 CHILD_POLICY_REPEAT 的指定元素的最大子元素數。例如,表示 8 位調色板條目的元素可能允許重複多達 256 次。Integer.MAX_VALUE 的值可用於指定不存在上限。

指定者:
介面 IIOMetadataFormat 中的 getElementMaxChildren
參數:
elementName - 要查詢的元素的名稱。
返回:
int

getElementDescription

public String getElementDescription(String elementName,
                                    Locale locale)
返回包含指定元素的描述的 String,或者 null。如果可能,應將描述本地化為提供的 Locale

預設實作利用在 ResourceBundle.getBundle 的註釋中描述的應變機制 (fallback mechanism),首先使用由 setResourceBaseName 設置的當前資源基本名稱以及所提供的 Locale 尋找 ResourceBundle。如果找到 ResourceBundle,則將元素名稱用作其 getString 方法的鍵並返回結果。如果未找到 ResourceBundle 或者不存在這樣的鍵,則返回 null

如果 localenull,則使用 Locale.getLocale 返回的當前預設 Locale

指定者:
介面 IIOMetadataFormat 中的 getElementDescription
參數:
elementName - 元素的名稱。
locale - 嘗試進行本地化的 Locale
返回:
元素描述。
拋出:
IllegalArgumentException - 如果 elementNamenull 或者不是此格式的合法元素名稱。
另請參見:
setResourceBaseName(java.lang.String)

getChildPolicy

public int getChildPolicy(String elementName)
從介面 IIOMetadataFormat 複製的描述
返回以 CHILD_POLICY_ 開頭的常數之一,指示指定元素子元素的合法網要。

指定者:
介面 IIOMetadataFormat 中的 getChildPolicy
參數:
elementName - 要查詢的元素的名稱。
返回:
CHILD_POLICY_* 常數之一。

getChildNames

public String[] getChildNames(String elementName)
從介面 IIOMetadataFormat 複製的描述
返回一個按出現順序排列的 String 陣列,指示允許作為指定元素子元素的元素的名稱。如果元素不能有子元素,則返回 null

指定者:
介面 IIOMetadataFormat 中的 getChildNames
參數:
elementName - 要查詢的元素的名稱。
返回:
String 陣列,或 null。

getAttributeNames

public String[] getAttributeNames(String elementName)
從介面 IIOMetadataFormat 複製的描述
返回一個 String 陣列,該陣列列出了與指定元素關聯的屬性的名稱。

指定者:
介面 IIOMetadataFormat 中的 getAttributeNames
參數:
elementName - 要查詢的元素的名稱。
返回:
String 陣列。

getAttributeValueType

public int getAttributeValueType(String elementName,
                                 String attrName)
從介面 IIOMetadataFormat 複製的描述
返回以 VALUE_ 開頭的常數之一,指示指定元素中給定屬性的值是任意值、被限制在指定範圍中的值、被限制為一組列舉值之一,還是一個任意值的以空白分隔的列表。

指定者:
介面 IIOMetadataFormat 中的 getAttributeValueType
參數:
elementName - 要查詢的元素的名稱。
attrName - 要查詢的屬性的名稱。
返回:
VALUE_* 常數之一。

getAttributeDataType

public int getAttributeDataType(String elementName,
                                String attrName)
從介面 IIOMetadataFormat 複製的描述
返回以 DATATYPE_ 開頭的常數之一,指示指定元素中給定屬性的值的格式和解釋。如果 getAttributeValueType 返回 VALUE_LIST,則合法值為返回資料型別的值的以空白分隔的列表。

指定者:
介面 IIOMetadataFormat 中的 getAttributeDataType
參數:
elementName - 要查詢的元素的名稱。
attrName - 要查詢的屬性的名稱。
返回:
DATATYPE_* 常數之一。

isAttributeRequired

public boolean isAttributeRequired(String elementName,
                                   String attrName)
從介面 IIOMetadataFormat 複製的描述
如果指定屬性必須在指定元素中存在,則返回 true

指定者:
介面 IIOMetadataFormat 中的 isAttributeRequired
參數:
elementName - 要查詢的元素的名稱。
attrName - 要查詢的屬性的名稱。
返回:
如果屬性必須存在,則返回 true

getAttributeDefaultValue

public String getAttributeDefaultValue(String elementName,
                                       String attrName)
從介面 IIOMetadataFormat 複製的描述
如果指定屬性不顯式存在於指定元素中,則以 String 的形式返回其預設值;如果不存在可用的預設值,則返回 null

指定者:
介面 IIOMetadataFormat 中的 getAttributeDefaultValue
參數:
elementName - 要查詢的元素的名稱。
attrName - 要查詢的屬性的名稱。
返回:
包含預設值的 String,或者 null

getAttributeEnumerations

public String[] getAttributeEnumerations(String elementName,
                                         String attrName)
從介面 IIOMetadataFormat 複製的描述
返回一個 String 陣列,其包含指定元素中給定屬性的合法列舉值。只應在 getAttributeValueType 返回 VALUE_ENUMERATION的情況下調用此方法。

指定者:
介面 IIOMetadataFormat 中的 getAttributeEnumerations
參數:
elementName - 要查詢的元素的名稱。
attrName - 要查詢的屬性的名稱。
返回:
String 陣列。

getAttributeMinValue

public String getAttributeMinValue(String elementName,
                                   String attrName)
從介面 IIOMetadataFormat 複製的描述
返回屬性的最小合法值。是否包括此值可由 getAttributeValueType 的值確定。該值以 String 的形式返回;其解釋依賴於 getAttributeDataType 的值。只應在 getAttributeValueType 返回 VALUE_RANGE_* 的情況下調用此方法。

指定者:
介面 IIOMetadataFormat 中的 getAttributeMinValue
參數:
elementName - 要查詢的元素的名稱。
attrName - 要查詢的屬性的名稱。
返回:
包含屬性的最小合法值的 String

getAttributeMaxValue

public String getAttributeMaxValue(String elementName,
                                   String attrName)
從介面 IIOMetadataFormat 複製的描述
返回屬性的最大合法值。是否包括此值可由 getAttributeValueType 的值確定。該值以 String 的形式返回;其解釋依賴於 getAttributeDataType 的值。只應在 getAttributeValueType 返回 VALUE_RANGE_* 的情況下調用此方法。

指定者:
介面 IIOMetadataFormat 中的 getAttributeMaxValue
參數:
elementName - 要查詢的 String 形式的元素名稱。
attrName - 要查詢的屬性的名稱。
返回:
包含屬性的最大合法值的 String

getAttributeListMinLength

public int getAttributeListMinLength(String elementName,
                                     String attrName)
從介面 IIOMetadataFormat 複製的描述
返回可用於定義此屬性的最小列表項數。屬性本身被定義為一個套件含多個由空白分隔的項的 String。只應在 getAttributeValueType 返回 VALUE_LIST 的情況下調用此方法。

指定者:
介面 IIOMetadataFormat 中的 getAttributeListMinLength
參數:
elementName - 要查詢的元素的名稱。
attrName - 要查詢的屬性的名稱。
返回:
屬性的列表項的最小合法數。

getAttributeListMaxLength

public int getAttributeListMaxLength(String elementName,
                                     String attrName)
從介面 IIOMetadataFormat 複製的描述
返回可用於定義此屬性的最大列表項數。Integer.MAX_VALUE 的值可用於指定不存在上限。屬性本身被定義為一個套件含多個由空白分隔的項的 String。只應在 getAttributeValueType 返回 VALUE_LIST 的情況下調用此方法。

指定者:
介面 IIOMetadataFormat 中的 getAttributeListMaxLength
參數:
elementName - 要查詢的元素的名稱。
attrName - 要查詢的屬性的名稱。
返回:
屬性的列表項的最大合法數。

getAttributeDescription

public String getAttributeDescription(String elementName,
                                      String attrName,
                                      Locale locale)
返回包含指定屬性的描述的 String,或者 null。如果可能,應將描述本地化為提供的 Locale

預設實作利用在 ResourceBundle.getBundle 的註釋中描述的應變機制,首先使用由 setResourceBaseName 設置的當前資源基本名稱以及所提供的 Locale 尋找 ResourceBundle。如果找到 ResourceBundle,則將後跟 "/" 字元再後跟屬性名 (elementName + "/" + attrName) 的元素名稱用作其 getString 方法的鍵,並返回結果。如果未找到 ResourceBundle 或者不存在這樣的鍵,則返回 null

如果 localenull,則使用 Locale.getLocale 返回的當前預設 Locale

指定者:
介面 IIOMetadataFormat 中的 getAttributeDescription
參數:
elementName - 元素的名稱。
attrName - 屬性的名稱。
locale - 嘗試進行本地化的 Locale,或者為 null
返回:
屬性描述。
拋出:
IllegalArgumentException - 如果 elementNamenull 或者不是此格式的合法元素名稱。
IllegalArgumentException - 如果 attrNamenull 或者不是此元素的合法屬性名稱。
另請參見:
setResourceBaseName(java.lang.String)

getObjectValueType

public int getObjectValueType(String elementName)
從介面 IIOMetadataFormat 複製的描述
返回以 VALUE_ 開頭的列舉值之一,指示允許用於 Object 參考的值(列舉、範圍或陣列)的型別。如果在給定元素中無法存儲任何物件值,則此方法的結果將為 VALUE_NONE

合法值被定義為範圍的 Object 參考必須實作 Comparable 介面。

指定者:
介面 IIOMetadataFormat 中的 getObjectValueType
參數:
elementName - 要查詢的元素的名稱。
返回:
VALUE_* 常數之一。
另請參見:
Comparable

getObjectClass

public Class<?> getObjectClass(String elementName)
從介面 IIOMetadataFormat 複製的描述
返回存儲在元素中的 Class 型別的 Object 參考。如果此元素不能包含 Object 參考,則拋出 IllegalArgumentException。如果類別型別為陣列,則此欄位指示底層類別型別(例如,對於 int 的陣列,此方法將返回 int.class)。

合法值被定義為範圍的 Object 參考必須實作 Comparable 介面。

指定者:
介面 IIOMetadataFormat 中的 getObjectClass
參數:
elementName - 要查詢的元素的名稱。
返回:
Class 物件。

getObjectDefaultValue

public Object getObjectDefaultValue(String elementName)
從介面 IIOMetadataFormat 複製的描述
返回包含指定元素中 Object 參考的預設值的 Object

指定者:
介面 IIOMetadataFormat 中的 getObjectDefaultValue
參數:
elementName - 要查詢的元素的名稱。
返回:
Object 物件。

getObjectEnumerations

public Object[] getObjectEnumerations(String elementName)
從介面 IIOMetadataFormat 複製的描述
返回一個 Object 陣列,該陣列包含指定元素中 Object 參考的合法列舉值。只應在 getObjectValueType 返回 VALUE_ENUMERATION的情況下調用此方法。

與接受列舉值的節點關聯的 Object 必須等於此方法返回的值之一,這裡的等於是由 == 運算符(而不是 Object.equals 方法)定義的。

指定者:
介面 IIOMetadataFormat 中的 getObjectEnumerations
參數:
elementName - 要查詢的元素的名稱。
返回:
Object 陣列。

getObjectMinValue

public Comparable<?> getObjectMinValue(String elementName)
從介面 IIOMetadataFormat 複製的描述
返回指定元素中 Object 參考的最小合法值。是否包括此值可由 getObjectValueType 的值確定。只應在 getObjectValueType 返回以 VALUE_RANGE 開頭的常數之一的情況下調用此方法。

指定者:
介面 IIOMetadataFormat 中的 getObjectMinValue
參數:
elementName - 要查詢的元素的名稱。
返回:
屬性的最小合法值。

getObjectMaxValue

public Comparable<?> getObjectMaxValue(String elementName)
從介面 IIOMetadataFormat 複製的描述
返回指定元素中 Object 參考的最大合法值。是否包括此值可由 getObjectValueType 的值確定。只應在 getObjectValueType 返回以 VALUE_RANGE 開頭的常數之一的情況下調用此方法。

指定者:
介面 IIOMetadataFormat 中的 getObjectMaxValue
參數:
elementName - 要查詢的元素的名稱。
返回:
屬性的最小合法值。

getObjectArrayMinLength

public int getObjectArrayMinLength(String elementName)
從介面 IIOMetadataFormat 複製的描述
返回指定元素中可用於定義 Object 參考的最小陣列元素數。只應在 getObjectValueType 返回 VALUE_LIST 的情況下調用此方法。

指定者:
介面 IIOMetadataFormat 中的 getObjectArrayMinLength
參數:
elementName - 要查詢的元素的名稱。
返回:
Object 參考的最小有效陣列長度。

getObjectArrayMaxLength

public int getObjectArrayMaxLength(String elementName)
從介面 IIOMetadataFormat 複製的描述
返回指定元素中可用於定義 Object 參考的最大陣列元素數。Integer.MAX_VALUE 的值可用於指定不存在上限。只應在 getObjectValueType 返回 VALUE_LIST 的情況下調用此方法。

指定者:
介面 IIOMetadataFormat 中的 getObjectArrayMaxLength
參數:
elementName - 要查詢的元素的名稱。
返回:
Object 參考的最大有效陣列長度。

getStandardFormatInstance

public static IIOMetadataFormat getStandardFormatInstance()
返回描述標準、外掛程式無關的 javax.imageio_1.0 元資料文檔格式的 IIOMetadataFormat 物件,該文檔格式在 javax.imageio.metadata 套件的註釋中描述。

返回:
預定義的 IIOMetadataFormat 實例。

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only