モジュール java.desktop
パッケージ javax.imageio.metadata

インタフェースIIOMetadataFormat

既知のすべての実装クラス:
IIOMetadataFormatImpl
public interface IIOMetadataFormat
IIOMetadata.getAsTreeから返されてIIOMetadata.setFromTreeとmergeTreeに渡されるメタデータ・ドキュメントの構造を記述するオブジェクトです。 ドキュメント構造は、指定された親の要素型に属すことができる子要素の型と数、要素に属すことができる属性の名前、型、および値、ならびにノードに格納できるObject参照の型と値に対する一連の制約により記述されます。

注: このインタフェースを実装するクラスは、クラスのインスタンスを返すpublic static getInstance()として宣言されるメソッドを格納する必要があります。 一般に、実装は1つのインスタンスだけを構築し、今後のgetInstanceの呼出しのためにキャッシュに格納します。

プラグインが名前付きモジュールの一部として提供される場合、そのモジュールは、実装クラスを含むパッケージを 

java.desktop
修飾されたエクスポート経由のモジュール。 その他の理由で必要とされない限り、非修飾エクスポートは推奨されません。 パッケージのエクスポートに失敗すると、実行時にアクセスが失敗します。

このクラスによって記述される構造は、XML文書型定義(DTD)を使用するクラスのサブセットであり、属性のデータ型とノード内にObject参照を格納する機能に関する一部の基本的な情報が追加されています。 将来は、XMLスキーマを使用してこれらの構造その他を表すことができる予定です。

IIOMetadataFormatによって記述される構造とDTDとの違いは、次のとおりです。

  • 要素にテキストを格納したり、テキストと埋込みタグを混在させたりすることはできません。
  • 要素の子は、CHILD_*定数のドキュメントに記述されている、数個の単純なパターンの1つに適合する必要があります。
  • メモリー内部の要素の表現はObjectへの参照を格納することができます。 このようなオブジェクトをテキストで表現する機能はありません。

  • フィールドのサマリー

    フィールド 
    修飾子と型 フィールド 説明
    static int CHILD_POLICY_ALL
    要素がその有効な子要素ごとに1つのインスタンスを順に持つ必要があることを示す、getChildPolicyから返される定数です。
    static int CHILD_POLICY_CHOICE
    要素がその有効な子要素の中から選択されたゼロまたは1つの子を持つ必要があることを示す、getChildPolicyから返される定数です。
    static int CHILD_POLICY_EMPTY
    要素が子を持つことができないことを示す、getChildPolicyから返される定数です。
    static int CHILD_POLICY_MAX
    範囲の確認に使用される、有効な最大のCHILD_POLICY_*定数です。
    static int CHILD_POLICY_REPEAT
    要素がその一意の有効な子要素のゼロ以上のインスタンスを持つ必要があることを示す、getChildPolicyから返される定数です。
    static int CHILD_POLICY_SEQUENCE
    要素がその有効な子要素のインスタンスのシーケンスを持つ必要があることを示す、getChildPolicyから返される定数です。
    static int CHILD_POLICY_SOME
    要素がその有効な子要素ごとにゼロまたは1つのインスタンスを順に持つ必要があることを示す、getChildPolicyから返される定数です。
    static int DATATYPE_BOOLEAN
    属性の値がboolean値trueまたはfalseであることを示す、getAttributeDataTypeから返される定数です。
    static int DATATYPE_DOUBLE
    属性の値が倍精度10進浮動小数点数の文字列表現であることを示す、getAttributeDataTypeから返される定数です。
    static int DATATYPE_FLOAT
    属性の値が10進浮動小数点数の文字列表現であることを示す、getAttributeDataTypeから返される定数です。
    static int DATATYPE_INTEGER
    属性の値が整数の文字列表現であることを示す、getAttributeDataTypeから返される定数です。
    static int DATATYPE_STRING
    属性の値が汎用Unicode文字列であることを示す、getAttributeDataTypeから返される定数です。
    static int VALUE_ARBITRARY
    属性またはユーザー・オブジェクトに1つの任意の値を設定できることを示す、getAttributeValueTypeおよびgetObjectValueTypeから返される定数です。
    static int VALUE_ENUMERATION
    属性またはユーザー・オブジェクトに列挙値の1つを設定できることを示す、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から返される定数です。

  • メソッドのサマリー

    修飾子と型 メソッド 説明
    boolean canNodeAppear​(String elementName, ImageTypeSpecifier imageType)
    要素とその下のサブツリーを、ImageTypeSpecifierで定義された、指定されたタイプのイメージのメタデータ・ドキュメントに表示できる場合は、trueを返します。
    int getAttributeDataType​(String elementName, String attrName)
    名前付き要素内の指定された属性の値の形式と解釈を示すDATATYPE_で始まる定数の1つを返します。
    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_で始まる定数の1つを返し、名前付き要素内の指定された属性の値が任意であるか、指定された範囲内に限定されるか、一連の列挙値の1つに限定されるか、または空白で区切られた任意の値のリストであるかどうかを示します。
    String[] getChildNames​(String elementName)
    名前付き要素の子になることができる要素の名前を示すStringの配列を出現順に返します。
    int getChildPolicy​(String elementName)
    名前付き要素の子の有効なパターンを示す、CHILD_POLICY_で始まる定数の1つを返します。
    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)
    要素内に格納されたObject参照のClass型を返します。
    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)
    Object参照に使用できる値(列挙、範囲、または配列)の型を示すVALUE_で始まる列挙値の1つを返します。
    String getRootName()
    形式のルート要素の名前を返します。
    boolean isAttributeRequired​(String elementName, String attrName)
    名前付き属性が名前付き要素内に存在する必要がある場合にtrueを返します。

  • フィールド詳細

    • CHILD_POLICY_EMPTY

      static final int CHILD_POLICY_EMPTY
      要素が子を持つことができないことを示す、getChildPolicyから返される定数です。 つまり、葉ノードである必要があります。
      関連項目:
      定数フィールド値

    • CHILD_POLICY_ALL

      static final int CHILD_POLICY_ALL
      要素がその有効な子要素ごとに1つのインスタンスを順に持つ必要があることを示す、getChildPolicyから返される定数です。 DTDの用語では、要素の内容はa,b,c,d,...の順に定義されます。
      関連項目:
      定数フィールド値

    • CHILD_POLICY_SOME

      static final int CHILD_POLICY_SOME
      要素がその有効な子要素ごとにゼロまたは1つのインスタンスを順に持つ必要があることを示す、getChildPolicyから返される定数です。 DTDの用語では、要素の内容はa?,b?,c?,d?,...の順に定義されます。
      関連項目:
      定数フィールド値

    • CHILD_POLICY_CHOICE

      static final int CHILD_POLICY_CHOICE
      要素がその有効な子要素の中から選択されたゼロまたは1つの子を持つ必要があることを示す、getChildPolicyから返される定数です。 DTDの用語では、要素の内容はa|b|c|d|...による選択で定義されます。
      関連項目:
      定数フィールド値

    • CHILD_POLICY_SEQUENCE

      static final int CHILD_POLICY_SEQUENCE
      要素がその有効な子要素のインスタンスのシーケンスを持つ必要があることを示す、getChildPolicyから返される定数です。 DTDの用語では、要素の内容は(a|b|c|d|...)*の順に定義されます。
      関連項目:
      定数フィールド値

    • CHILD_POLICY_REPEAT

      static final int CHILD_POLICY_REPEAT
      要素がその一意の有効な子要素のゼロ以上のインスタンスを持つ必要があることを示す、getChildPolicyから返される定数です。 DTDの用語では、要素の内容は星の付いた式a*によって定義されます。
      関連項目:
      定数フィールド値

    • CHILD_POLICY_MAX

      static final int CHILD_POLICY_MAX
      範囲の確認に使用される、有効な最大のCHILD_POLICY_*定数です。
      関連項目:
      定数フィールド値

    • VALUE_NONE

      static final int VALUE_NONE
      ユーザー・オブジェクトがないことを示す、getObjectValueTypeから返される定数です。
      関連項目:
      定数フィールド値

    • VALUE_ARBITRARY

      static final int VALUE_ARBITRARY
      属性またはユーザー・オブジェクトに1つの任意の値を設定できることを示す、getAttributeValueTypeおよびgetObjectValueTypeから返される定数です。
      関連項目:
      定数フィールド値

    • VALUE_RANGE

      static final int VALUE_RANGE
      属性またはユーザー・オブジェクトに値の範囲を設定できることを示す、getAttributeValueTypeおよびgetObjectValueTypeから返される定数です。 範囲の最大値と最小値は両方とも範囲に含まれません。 整数の範囲の場合は両端を含むようにし、両端を含まない範囲は浮動小数点データの場合にだけ使うようにすることをお薦めします。
      関連項目:
      VALUE_RANGE_MIN_MAX_INCLUSIVE、定数フィールド値

    • 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の値との論理積を求めて、範囲の最小値が範囲に含まれるかどうかを判定します。

      関連項目:
      定数フィールド値

    • 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の値との論理積を求めて、範囲の最大値が範囲に含まれるかどうかを判定します。

      関連項目:
      定数フィールド値

    • VALUE_RANGE_MIN_INCLUSIVE

      static final int VALUE_RANGE_MIN_INCLUSIVE
      属性またはユーザー・オブジェクトに値の範囲を設定できることを示す、getAttributeValueTypeおよびgetObjectValueTypeから返される定数です。 範囲の最小値(ただし、最大値ではありません)は範囲に含まれます。
      関連項目:
      定数フィールド値

    • VALUE_RANGE_MAX_INCLUSIVE

      static final int VALUE_RANGE_MAX_INCLUSIVE
      属性またはユーザー・オブジェクトに値の範囲を設定できることを示す、getAttributeValueTypeおよびgetObjectValueTypeから返される定数です。 範囲の最大値(ただし、最小値ではありません)は範囲に含まれます。
      関連項目:
      定数フィールド値

    • VALUE_RANGE_MIN_MAX_INCLUSIVE

      static final int VALUE_RANGE_MIN_MAX_INCLUSIVE
      属性またはユーザー・オブジェクトに値の範囲を設定できることを示す、getAttributeValueTypeおよびgetObjectValueTypeから返される定数です。 範囲の最大値と最小値は両方とも範囲に含まれます。 整数の範囲の場合は両端を含むようにし、両端を含まない範囲は浮動小数点データの場合にだけ使うようにすることをお薦めします。
      関連項目:
      定数フィールド値

    • VALUE_ENUMERATION

      static final int VALUE_ENUMERATION
      属性またはユーザー・オブジェクトに列挙値の1つを設定できることを示す、getAttributeValueTypeおよびgetObjectValueTypeから返される定数です。 属性の場合、これらの値はStringであり、オブジェクトの場合は、指定されたクラスまたはインタフェースを実装するObjectです。

      DATATYPE_BOOLEAN型の属性値は列挙としてマークされます。

      関連項目:
      定数フィールド値

    • VALUE_LIST

      static final int VALUE_LIST
      属性またはユーザー・オブジェクトに値のリストまたは配列を設定できることを示す、getAttributeValueTypeおよびgetObjectValueTypeから返される定数です。 属性の場合、リストは空白で区切られたString内の値で構成され、オブジェクトの場合は、配列が使用されます。
      関連項目:
      定数フィールド値

    • DATATYPE_STRING

      static final int DATATYPE_STRING
      属性の値が汎用Unicode文字列であることを示す、getAttributeDataTypeから返される定数です。
      関連項目:
      定数フィールド値

    • DATATYPE_BOOLEAN

      static final int DATATYPE_BOOLEAN
      属性の値がboolean値trueまたはfalseであることを示す、getAttributeDataTypeから返される定数です。 DATATYPE_BOOLEAN型の属性値は列挙としてマークされ、プラグインが小文字または大文字と小文字が混在する場合の等価も認識できるとしても、許可される値は文字列リテラルの値「TRUE」または「FALSE」である必要があります。
      関連項目:
      定数フィールド値

    • DATATYPE_INTEGER

      static final int DATATYPE_INTEGER
      属性の値が整数の文字列表現であることを示す、getAttributeDataTypeから返される定数です。
      関連項目:
      定数フィールド値

    • DATATYPE_FLOAT

      static final int DATATYPE_FLOAT
      属性の値が10進浮動小数点数の文字列表現であることを示す、getAttributeDataTypeから返される定数です。
      関連項目:
      定数フィールド値

    • DATATYPE_DOUBLE

      static final int DATATYPE_DOUBLE
      属性の値が倍精度10進浮動小数点数の文字列表現であることを示す、getAttributeDataTypeから返される定数です。
      関連項目:
      定数フィールド値

  • メソッドの詳細

    • getRootName

      String getRootName()
      形式のルート要素の名前を返します。
      戻り値:
      String。

    • canNodeAppear

      boolean canNodeAppear​(String elementName, ImageTypeSpecifier imageType)
      要素とその下のサブツリーを、ImageTypeSpecifierで定義された、指定されたタイプのイメージのメタデータ・ドキュメントに表示できる場合は、trueを返します。 たとえば、メタデータ・ドキュメント形式にはイメージの一次色を記述する要素が格納される場合がありますが、グレー・スケール・イメージを記述する場合には使用できません。
      パラメータ:
      elementName - 照会される要素の名前。
      imageType - メタデータと関連するイメージのタイプを示すImageTypeSpecifier。
      戻り値:
      指定されたタイプのイメージに対してノードが有効な場合はtrue。

    • getElementMinChildren

      int getElementMinChildren​(String elementName)
      子ポリシーCHILD_POLICY_REPEATを持つ名前付き要素の子の最小数を返します。 たとえば、色の一次情報を表す要素には、各一次色に1つ、少なくとも3つの子が必要になる場合があります。
      パラメータ:
      elementName - 照会される要素の名前。
      戻り値:
      int。
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。
      IllegalArgumentException - 名前付き要素が子ポリシーCHILD_POLICY_REPEATを持っていない場合。

    • getElementMaxChildren

      int getElementMaxChildren​(String elementName)
      子ポリシーCHILD_POLICY_REPEATを持つ名前付き要素の子の最大数を返します。 たとえば、8ビットのカラー・パレット内のエントリを表す要素は256回まで反復できる場合があります。 Integer.MAX_VALUEの値を使用して、上限なしを指定することができます。
      パラメータ:
      elementName - 照会される要素の名前。
      戻り値:
      int。
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。
      IllegalArgumentException - 名前付き要素が子ポリシーCHILD_POLICY_REPEATを持っていない場合。

    • getElementDescription

      String getElementDescription​(String elementName, Locale locale)
      名前付き要素の説明を格納したString、またはnullを返します。 説明は、可能であれば、指定されたLocaleにローカライズされます。

      localeがnullの場合、Locale.getLocaleによって返された現在のデフォルトLocaleが使用されます。

      パラメータ:
      elementName - 要素の名前。
      locale - ローカリゼーションを試みる対象となるLocale。
      戻り値:
      要素の説明。
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。

    • getChildPolicy

      int getChildPolicy​(String elementName)
      名前付き要素の子の有効なパターンを示す、CHILD_POLICY_で始まる定数の1つを返します。
      パラメータ:
      elementName - 照会される要素の名前。
      戻り値:
      CHILD_POLICY_*定数の1つ。
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。

    • getChildNames

      String[] getChildNames​(String elementName)
      名前付き要素の子になることができる要素の名前を示すStringの配列を出現順に返します。 要素が子を持つことができない場合は、nullが返されます。
      パラメータ:
      elementName - 照会される要素の名前。
      戻り値:
      Stringの配列、またはnull。
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。

    • getAttributeNames

      String[] getAttributeNames​(String elementName)
      名前付き要素に関連付けることができる属性の名前をリスト表示するStringの配列を返します。
      パラメータ:
      elementName - 照会される要素の名前。
      戻り値:
      Stringの配列。
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。

    • getAttributeValueType

      int getAttributeValueType​(String elementName, String attrName)
      VALUE_で始まる定数の1つを返し、名前付き要素内の指定された属性の値が任意であるか、指定された範囲内に限定されるか、一連の列挙値の1つに限定されるか、または空白で区切られた任意の値のリストであるかどうかを示します。
      パラメータ:
      elementName - 照会される要素の名前。
      attrName - 照会される属性の名前。
      戻り値:
      VALUE_*定数の1つ。
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。
      IllegalArgumentException - attrNameがnullの場合、またはこの要素の有効な属性名でない場合。

    • getAttributeDataType

      int getAttributeDataType​(String elementName, String attrName)
      名前付き要素内の指定された属性の値の形式と解釈を示すDATATYPE_で始まる定数の1つを返します。 getAttributeValueTypeがVALUE_LISTを返す場合、有効な値は、返されるデータ型の値の空白で区切られたリストです。
      パラメータ:
      elementName - 照会される要素の名前。
      attrName - 照会される属性の名前。
      戻り値:
      DATATYPE_*定数の1つ。
      例外:
      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の値で判定することができます。 値はStringとして返されます。その解釈はgetAttributeDataTypeの値により異なります。 このメソッドは、getAttributeValueTypeがVALUE_RANGE_*を返す場合にだけ呼び出します。
      パラメータ:
      elementName - 照会される要素の名前。
      attrName - 照会される属性の名前。
      戻り値:
      属性の有効な最小値が格納されているString。
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。
      IllegalArgumentException - attrNameがnullの場合、またはこの要素の有効な属性名でない場合。
      IllegalArgumentException - 指定された属性が範囲として定義されていない場合。

    • getAttributeMaxValue

      String getAttributeMaxValue​(String elementName, String attrName)
      属性の有効な最大値を返します。 この値を含むか含まないかは、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、またはnullを返します。 説明は、可能であれば、指定されたLocaleにローカライズされます。

      localeがnullの場合、Locale.getLocaleによって返された現在のデフォルトLocaleが使用されます。

      パラメータ:
      elementName - 要素の名前。
      attrName - 属性の名前。
      locale - ローカリゼーションを試みる対象となるLocale。
      戻り値:
      属性の説明
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。
      IllegalArgumentException - attrNameがnullの場合、またはこの要素の有効な属性名でない場合。

    • getObjectValueType

      int getObjectValueType​(String elementName)
      Object参照に使用できる値(列挙、範囲、または配列)の型を示すVALUE_で始まる列挙値の1つを返します。 指定された要素内にオブジェクトの値を格納できない場合、このメソッドの結果はVALUE_NONEになります。

      有効な値が範囲として定義されるObject参照は、Comparableインタフェースを実装する必要があります。

      パラメータ:
      elementName - 照会される要素の名前。
      戻り値:
      VALUE_*定数の1つ。
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。
      関連項目:
      Comparable

    • getObjectClass

      Class<?> getObjectClass​(String elementName)
      要素内に格納されたObject参照のClass型を返します。 この要素にObject参照を格納できない場合は、IllegalArgumentExceptionがスローされます。 クラス型が配列である場合、このフィールドは基本となるクラス型を示します(たとえば、intの配列の場合、このメソッドはint.classを返します)。

      有効な値が範囲として定義されるObject参照は、Comparableインタフェースを実装する必要があります。

      パラメータ:
      elementName - 照会される要素の名前。
      戻り値:
      Classオブジェクト。
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。
      IllegalArgumentException - 名前付き要素がオブジェクトの値を格納できない場合(つまり、getObjectValueType(elementName)== VALUE_NONEの場合)。

    • getObjectDefaultValue

      Object getObjectDefaultValue​(String elementName)
      名前付き要素内のObject参照のデフォルト値が格納されているObjectを返します。
      パラメータ:
      elementName - 照会される要素の名前。
      戻り値:
      Object。
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。
      IllegalArgumentException - 名前付き要素がオブジェクトの値を格納できない場合(つまり、getObjectValueType(elementName)== VALUE_NONEの場合)。

    • getObjectEnumerations

      Object[] getObjectEnumerations​(String elementName)
      名前付き要素内のObject参照の有効な列挙値が格納されているObjectの配列を返します。 このメソッドは、getObjectValueTypeがVALUE_ENUMERATIONを返す場合にだけ呼び出します。

      ==演算子で定義されるように(Object.equalsメソッドとは異なります)、列挙値を受け取るノードに関連付けられたObjectは、このメソッドから返される値の1つと等しくなければいけません。

      パラメータ:
      elementName - 照会される要素の名前。
      戻り値:
      Objectの配列。
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。
      IllegalArgumentException - 名前付き要素がオブジェクトの値を格納できない場合(つまり、getObjectValueType(elementName)== VALUE_NONEの場合)。
      IllegalArgumentException - Objectが列挙として定義されていない場合。

    • getObjectMinValue

      Comparable<?> getObjectMinValue​(String elementName)
      名前付き要素内のObject参照の有効な最小値を返します。 この値を含むか含まないかは、getObjectValueTypeの値で判定することができます。 このメソッドは、getObjectValueTypeがVALUE_RANGEで始まる定数の1つを返す場合にだけ呼び出します。
      パラメータ:
      elementName - 照会される要素の名前。
      戻り値:
      属性の有効な最小値。
      例外:
      IllegalArgumentException - elementNameがnullの場合、またはこの形式の有効な要素名でない場合。
      IllegalArgumentException - 名前付き要素がオブジェクトの値を格納できない場合(つまり、getObjectValueType(elementName)== VALUE_NONEの場合)。
      IllegalArgumentException - Objectが範囲として定義されていない場合。

    • getObjectMaxValue

      Comparable<?> getObjectMaxValue​(String elementName)
      名前付き要素内のObject参照の有効な最大値を返します。 この値を含むか含まないかは、getObjectValueTypeの値で判定することができます。 このメソッドは、getObjectValueTypeがVALUE_RANGEで始まる定数の1つを返す場合にだけ呼び出します。
      パラメータ:
      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が配列でない場合。