javax.imageio.metadata
インタフェース IIOMetadataFormat

既知の実装クラスの一覧:

IIOMetadataFormatImpl

public interface IIOMetadataFormat

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

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

このクラスによって記述される構造は、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 属性の値が 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 として返します。
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

属性の値が true または false であることを示す、getAttributeDataType から返される定数です。

関連項目:

定数フィールド値

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 が配列でない場合