javax.imageio.metadata
クラス IIOMetadataFormatImpl

java.lang.Object
  |
  +--javax.imageio.metadata.IIOMetadataFormatImpl

すべての実装インタフェース:

IIOMetadataFormat

public abstract class IIOMetadataFormatImpl

extends Object

implements IIOMetadataFormat

IIOMetadataFormat インタフェースの再使用可能な実装を提供する具象クラスです。さらに、標準の、プラグインに依存しない javax_imageio_1.0 形式を表す静的インスタンスが getStandardFormatInstance メソッドにより提供されます。

地域に対応した要素と属性の説明を提供するためには、this.getClass().getName() + "Resources" のベース名を持つ ResourceBundle を、ResourceBundle.getBundle で使用される通常の機構を介して提供する必要があります。つまり、サブクラサは命名規則に従って 1 つまたは複数の追加クラスを提供します (デフォルトでは、IIMetadataFormatImpl、文字列 "Resources"、国、言語、およびバリアントのアンダースコアで区切られたコ−ドを拡張するサブクラスの完全指定名)。実行時には、getElementDescription または getAttributeDescription の呼び出しによって、指定されたロケールに従ってこのようなクラスの動的なロードが試行され、要素名、またはあとに「/」文字と属性名が続く要素名がキーとして使用されます。このキーは ResourceBundle の getString メソッドに提供され、地域に対応したノードまたは属性の説明が返されます。

サブクラスは、setResourceBaseName メソッドを使用してリソースバンドルの異なるベース名を提供できます。

必要に応じて、サブクラスは、getElementDescription および getAttributeDescription の提供された実装をオーバーライドして、独自の地域対応機構を選択できます。

関連項目:

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)
指定されたルート要素名と子ポリシー (CHILD_POLICY_REPEAT 以外) を使用して、空白の IIOMetadataFormatImpl インスタンスを構築します。

IIOMetadataFormatImpl(String rootName, int minChildren, int maxChildren)
指定されたルート要素名と CHILD_POLICY_REPEAT の子ポリシーを使用して、空白の IIOMetadataFormatImpl インスタンスを構築します。

メソッドの概要

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 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) 新しい属性を、DATATYPE_BOOLEAN のデータ型で、列挙値 TRUE および FALSE で定義される事前に定義された要素に追加します。
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, boolean required, Object defaultValue) 指定されたクラス型の Object 参照を、名前付き要素を実装するノードに格納できるようにします。
protected void	addObjectValue(String elementName, Class classType, boolean required, Object defaultValue, List enumeratedValues) 指定されたクラス型の Object 参照を、名前付き要素を実装するノードに格納できるようにします。
protected void	addObjectValue(String elementName, Class classType, int arrayMinLength, int arrayMaxLength) 指定されたクラス型の Object 参照を、名前付き要素を実装するノードに格納できるようにします。
protected void	addObjectValue(String elementName, Class classType, Object defaultValue, Comparable minValue, Comparable maxValue, boolean minInclusive, boolean maxInclusive) 指定されたクラス型の Object 参照を、名前付き要素を実装するノードに格納できるようにします。
abstract 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 つを返します。
protected String	getResourceBaseName() ResourceBundle を検索するための、現在設定されているベース名を返します。
String	getRootName() 形式のルート要素の名前を返します。
static IIOMetadataFormat	getStandardFormatInstance() javax.imageio.metadata パッケージのコメントに記述されている、標準の、プラグインに依存しない javax.imageio_1.0 メタデータドキュメント形式を記述する IIOMetadataFormat オブジェクトを返します。
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)

指定されたルート要素名と子ポリシー (CHILD_POLICY_REPEAT 以外) を使用して、空白の IIOMetadataFormatImpl インスタンスを構築します。追加要素、その属性、および Object 参照情報は、各種の add メソッドを使用して追加できます。

パラメータ:

rootName - ルート要素の名前

childPolicy - CHILD_POLICY_REPEAT 以外の、CHILD_POLICY_* 定数の 1 つ

例外:

IllegalArgumentException - rootName が null の場合

IllegalArgumentException - childPolicy が事前に定義された定数の 1 つでない場合

IIOMetadataFormatImpl

public IIOMetadataFormatImpl(String rootName,
                             int minChildren,
                             int maxChildren)

指定されたルート要素名と CHILD_POLICY_REPEAT の子ポリシーを使用して、空白の IIOMetadataFormatImpl インスタンスを構築します。追加要素と、その属性および Object 参照情報は、各種の add メソッドを使用して追加できます。

パラメータ:

rootName - ルート要素の名前

minChildren - ノードの子の最小数

maxChildren - ノードの子の最大数

例外:

IllegalArgumentException - rootName が null の場合

IllegalArgumentException - minChildren が負の値の場合、または maxChildren より大きい場合

メソッドの詳細

setResourceBaseName

protected void setResourceBaseName(String resourceBaseName)

この形式の要素と属性の説明が格納されている ResourceBundle を検索するための新しいベース名を設定します。

最初にこのメソッドを呼び出すまでは、ベース名は this.getClass().getName() + "Resources" に等しくなっています。

パラメータ:

resourceBaseName - 新しいベース名が格納されている String

例外:

IllegalArgumentException - resourceBaseName が null の場合

関連項目:

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_* 定数の 1 つ

例外:

IllegalArgumentException - parentName が null の場合、またはこの形式の有効な要素名でない場合

IllegalArgumentException - childPolicy が事前に定義された定数の 1 つでない場合

addElement

protected void addElement(String elementName,
                          String parentName,
                          int minChildren,
                          int maxChildren)

CHILD_POLICY_REPEAT の子ポリシーを持つこのメタデータドキュメント形式に新しい要素型を追加します。

パラメータ:

elementName - 新しい要素の名前

parentName - 新しい要素の親になる要素の名前

minChildren - ノードの子の最小数

maxChildren - ノードの子の最大数

例外:

IllegalArgumentException - parentName が null の場合、またはこの形式の有効な要素名でない場合

IllegalArgumentException - minChildren が負の値の場合、または maxChildren より大きい場合

addChildElement

protected void addChildElement(String elementName,
                               String parentName)

既存の要素を、指定された親ノードの型の有効な子のリストに追加します。

パラメータ:

parentName - 要素の新しい親になる要素の名前

elementName - 子として追加される要素の名前

例外:

IllegalArgumentException - elementName が null の場合、またはこの形式の有効な要素名でない場合

IllegalArgumentException - parentName が null の場合、またはこの形式の有効な要素名でない場合

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_* 定数の 1 つ

required - 属性が存在する必要がある場合は true

defaultValue - 属性のデフォルト値、または null

例外:

IllegalArgumentException - elementName が null の場合、またはこの形式の有効な要素名でない場合

IllegalArgumentException - attrName が null の場合

IllegalArgumentException - dataType が事前に定義された定数の 1 つでない場合

addAttribute

protected void addAttribute(String elementName,
                            String attrName,
                            int dataType,
                            boolean required,
                            String defaultValue,
                            List enumeratedValues)

新しい属性を、列挙値のセットで定義される事前に定義された要素に追加します。

パラメータ:

elementName - 要素の名前

attrName - 追加される属性の名前

dataType - 属性のデータ型 (文字列形式) で、DATATYPE_* 定数の 1 つ

required - 属性が存在する必要がある場合は true

defaultValue - 属性のデフォルト値、または null

enumeratedValues - 属性の有効な値が格納されている String の List

例外:

IllegalArgumentException - elementName が null の場合、またはこの形式の有効な要素名でない場合

IllegalArgumentException - attrName が null の場合

IllegalArgumentException - dataType が事前に定義された定数の 1 つでない場合

IllegalArgumentException - enumeratedValues が null の場合

IllegalArgumentException - enumeratedValues にエントリが 1 つも格納されていない場合

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_* 定数の 1 つ

required - 属性が存在する必要がある場合は true

defaultValue - 属性のデフォルト値、または null

minValue - String としての、属性の最小 (この値を含むか含まないかは minInclusive の値によって決まる) の有効な値

maxValue - String としての、属性の最大 (この値を含むか含まないかは minInclusive の値によって決まる) の有効な値

minInclusive - minValue が範囲に含まれる場合は true

maxInclusive - maxValue が範囲に含まれる場合は true

例外:

IllegalArgumentException - elementName が null の場合、またはこの形式の有効な要素名でない場合

IllegalArgumentException - attrName が null の場合

IllegalArgumentException - dataType が事前に定義された定数の 1 つでない場合

addAttribute

protected void addAttribute(String elementName,
                            String attrName,
                            int dataType,
                            boolean required,
                            int listMinLength,
                            int listMaxLength)

新しい属性を、値のリストで定義される事前に定義された要素に追加します。

パラメータ:

elementName - 要素の名前

attrName - 追加される属性の名前

dataType - 属性のデータ型 (文字列形式) で、DATATYPE_* 定数の 1 つ

required - 属性が存在する必要がある場合は true

listMinLength - リスト項目の有効な最小数

listMaxLength - リスト項目の有効な最大数

例外:

IllegalArgumentException - elementName が null の場合、またはこの形式の有効な要素名でない場合

IllegalArgumentException - attrName が null の場合

IllegalArgumentException - dataType が事前に定義された定数の 1 つでない場合

IllegalArgumentException - listMinLength が負の値の場合、または listMaxLength より大きい場合

addBooleanAttribute

protected void addBooleanAttribute(String elementName,
                                   String attrName,
                                   boolean hasDefaultValue,
                                   boolean defaultValue)

新しい属性を、DATATYPE_BOOLEAN のデータ型で、列挙値 TRUE および FALSE で定義される事前に定義された要素に追加します。

パラメータ:

elementName - 要素の名前

attrName - 追加される属性の名前

hasDefaultValue - デフォルト値が存在する必要がある場合は true

defaultValue - boolean としての属性のデフォルト値。hasDefaultValue が false の場合は無視される

例外:

IllegalArgumentException - elementName が null の場合、またはこの形式の有効な要素名でない場合

IllegalArgumentException - attrName が null の場合

removeAttribute

protected void removeAttribute(String elementName,
                               String attrName)

事前に定義された要素から属性を削除します。指定された名前を持つ属性が指定された要素内に存在しなかった場合は、何も実行されず、例外はスローされません。

パラメータ:

elementName - 要素の名前

attrName - 削除される属性の名前

例外:

IllegalArgumentException - elementName が null の場合、またはこの形式の有効な要素名でない場合

addObjectValue

protected void addObjectValue(String elementName,
                              Class classType,
                              boolean required,
                              Object defaultValue)

指定されたクラス型の Object 参照を、名前付き要素を実装するノードに格納できるようにします。Object の値は、そのクラス型による以外には制限されません。

Object 参照が以前に許可された場合、以前の設定値は上書きされます。

パラメータ:

elementName - 要素の名前

classType - オブジェクト値の有効なクラス型を示す Class 変数

required - オブジェクト値が存在する必要がある場合は true

defaultValue - Object 参照のデフォルト値、または null

例外:

IllegalArgumentException - elementName が null の場合、またはこの形式の有効な要素名でない場合

addObjectValue

protected void addObjectValue(String elementName,
                              Class classType,
                              boolean required,
                              Object defaultValue,
                              List enumeratedValues)

指定されたクラス型の Object 参照を、名前付き要素を実装するノードに格納できるようにします。Object の値は、enumeratedValues で指定された値の 1 つでなければなりません。

Object 参照が以前に許可された場合、以前の設定値は上書きされます。

パラメータ:

elementName - 要素の名前

classType - オブジェクト値の有効なクラス型を示す Class 変数

required - オブジェクト値が存在する必要がある場合は true

defaultValue - Object 参照のデフォルト値、または null

enumeratedValues - オブジェクト参照の有効な値が格納されている Object の List

例外:

IllegalArgumentException - elementName が null の場合、またはこの形式の有効な要素名でない場合

IllegalArgumentException - enumeratedValues が null の場合

IllegalArgumentException - enumeratedValues にエントリが 1 つも格納されていない場合

IllegalArgumentException - enumeratedValues に、classType で示されるクラス型のインスタンスでない要素、または null である要素が格納されている場合

addObjectValue

protected void addObjectValue(String elementName,
                              Class classType,
                              Object defaultValue,
                              Comparable minValue,
                              Comparable maxValue,
                              boolean minInclusive,
                              boolean maxInclusive)

指定されたクラス型の Object 参照を、名前付き要素を実装するノードに格納できるようにします。Object の値は、minValue および maxValue で指定される範囲内になければなりません。さらに、このクラス型は Comparable インタフェースを実装する必要があります。

Object 参照が以前に許可された場合、以前の設定値は上書きされます。

パラメータ:

elementName - 要素の名前

classType - オブジェクト値の有効なクラス型を示す Class 変数

defaultValue - オブジェクト参照のデフォルト値または null

minValue - String としての、オブジェクト値の最小 (この値を含むか含まないかは minInclusive の値によって決まる) の有効な値

maxValue - String としての、オブジェクト値の最大 (この値を含むか含まないかは minInclusive の値によって決まる) の有効な値

minInclusive - minValue が範囲に含まれる場合は true

maxInclusive - maxValue が範囲に含まれる場合は true

例外:

IllegalArgumentException - elementName が null の場合、またはこの形式の有効な要素名でない場合

addObjectValue

protected void addObjectValue(String elementName,
                              Class classType,
                              int arrayMinLength,
                              int arrayMaxLength)

指定されたクラス型の Object 参照を、名前付き要素を実装するノードに格納できるようにします。Object の値は、少なくとも arrayMinLength の要素、最大で arrayMaxLength の要素を持つ、classType で指定されたクラス型のオブジェクトの配列でなければなりません。

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 を持つ名前付き要素の子の最小数を返します。たとえば、色の一次情報を表す要素には、各一次色に 1 つ、少なくとも 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 の地域に対応します。

デフォルトの実装は、まず setResourceBaseName で設定された現在のリソースのベース名を使用して ResourceBundle を検索し、ResourceBundle.getBundle のコメントに記述された代替機構を使用して、指定された Locale を検索します。ResourceBundle が見つかった場合は、要素名がその getString メソッドのキーとして使用され、結果が返されます。ResourceBundle が見つからないか、そのようなキーが存在しない場合は、null が返されます。

locale が null の場合は、Locale.getLocale から返される現在のデフォルトの Locale が使用されます。

定義:

インタフェース IIOMetadataFormat 内の getElementDescription

パラメータ:

elementName - 要素の名前

locale - 地域対応を試みる、対象となる Locale

戻り値:

要素の説明

例外:

IllegalArgumentException - elementName が null の場合、またはこの形式の有効な要素名でない場合

関連項目:

setResourceBaseName(java.lang.String)

getChildPolicy

public int getChildPolicy(String elementName)

インタフェース IIOMetadataFormat の記述:

名前付き要素の子の有効なパターンを示す、CHILD_POLICY_ で始まる定数の 1 つを返します。

定義:

インタフェース IIOMetadataFormat 内の getChildPolicy

パラメータ:

elementName - 照会される要素の名前

戻り値:

CHILD_POLICY_* 定数の 1 つ

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_ で始まる定数の 1 つを返し、名前付き要素内の指定された属性の値が任意であるか、指定された範囲内に限定されるか、一連の列挙値の 1 つに限定されるか、または空白で区切られた任意の値のリストであるかどうかを示します。

定義:

インタフェース IIOMetadataFormat 内の getAttributeValueType

パラメータ:

elementName - 照会される要素の名前

attrName - 照会される属性の名前

戻り値:

VALUE_* 定数の 1 つ

getAttributeDataType

public int getAttributeDataType(String elementName,
                                String attrName)

インタフェース IIOMetadataFormat の記述:

名前付き要素内の指定された属性の値の形式と解釈を示す DATATYPE_ で始まる定数の 1 つを返します。getAttributeValueType が VALUE_LIST を返す場合、有効な値は、返されるデータ型の値の空白で区切られたリストです。

定義:

インタフェース IIOMetadataFormat 内の getAttributeDataType

パラメータ:

elementName - 照会される要素の名前

attrName - 照会される属性の名前

戻り値:

DATATYPE_* 定数の 1 つ

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 の地域に対応します。

デフォルトの実装は、まず setResourceBaseName で設定された現在のリソースのベース名を使用して ResourceBundle を検索し、ResourceBundle.getBundle のコメントに記述された代替機構を使用して、指定された Locale を検索します。ResourceBundle が見つかった場合は、あとに「/」文字と属性名が続く要素名 (elementName + "/" + attrName) がその getString メソッドのキーとして使用され、結果が返されます。ResourceBundle が見つからないか、そのようなキーが存在しない場合は、null が返されます。

locale が null の場合は、Locale.getLocale から返される現在のデフォルトの Locale が使用されます。

定義:

インタフェース IIOMetadataFormat 内の getAttributeDescription

パラメータ:

elementName - 要素の名前

attrName - 属性の名前

locale - 地域対応を試みる、対象となる Locale、または null

戻り値:

属性の説明

例外:

IllegalArgumentException - elementName が null の場合、またはこの形式の有効な要素名でない場合

IllegalArgumentException - attrName が null の場合、またはこの要素の有効な属性名でない場合

関連項目:

setResourceBaseName(java.lang.String)

getObjectValueType

public int getObjectValueType(String elementName)

インタフェース IIOMetadataFormat の記述:

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

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

定義:

インタフェース IIOMetadataFormat 内の getObjectValueType

パラメータ:

elementName - 照会される要素の名前

戻り値:

VALUE_* 定数の 1 つ

関連項目:

Comparable

getObjectClass

public Class getObjectClass(String elementName)

インタフェース IIOMetadataFormat の記述:

要素内に格納された Object 参照の Class 型を返します。この要素に 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.equals メソッドとは異なる)、列挙値を受け取るノードに関連付けられた Object は、このメソッドから返される値の 1 つと等しくなければなりません。

定義:

インタフェース IIOMetadataFormat 内の getObjectEnumerations

パラメータ:

elementName - 照会される要素の名前

戻り値:

Object の配列

getObjectMinValue

public Comparable getObjectMinValue(String elementName)

インタフェース IIOMetadataFormat の記述:

名前付き要素内の Object 参照の有効な最小値を返します。この値を含むか含まないかは、getObjectValueType の値で判定することができます。このメソッドは、getObjectValueType が VALUE_RANGE で始まる定数の 1 つを返す場合にだけ呼び出します。

定義:

インタフェース IIOMetadataFormat 内の getObjectMinValue

パラメータ:

elementName - 照会される要素の名前

戻り値:

属性の有効な最小値

getObjectMaxValue

public Comparable getObjectMaxValue(String elementName)

インタフェース IIOMetadataFormat の記述:

名前付き要素内の Object 参照の有効な最大値を返します。この値を含むか含まないかは、getObjectValueType の値で判定することができます。このメソッドは、getObjectValueType が VALUE_RANGE で始まる定数の 1 つを返す場合にだけ呼び出します。

定義:

インタフェース 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.metadata パッケージのコメントに記述されている、標準の、プラグインに依存しない javax.imageio_1.0 メタデータドキュメント形式を記述する IIOMetadataFormat オブジェクトを返します。

戻り値:

事前に定義された IIOMetadataFormat インスタンス