javax.management
インタフェース Descriptor

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

Cloneable, Serializable

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

DescriptorSupport

public interface Descriptor
extends Serializable, Cloneable

このインタフェースは、JMX 要素の動作のメタデータセットを表します。たとえば、記述子は ModelMBeanInfo、ModelMBeanNotificationInfo、ModelMBeanAttributeInfo、ModelMBeanConstructorInfo、および ModelMBeanParameterInfo の一部になります。

記述子は複数のフィールドから成ります。各フィールドは fieldname=fieldvalue の形式になっています。

すべてのフィールドの名前と値は未定義です。任意のプログラムで新しいフィールドを定義し、追加することができます。ModelMBean には、実装の整合性を確保し、ModelMBeanInfo、ModelMBean*Info、および ModelMBean クラスによるサポートを得るため、あらかじめ定義済みのフィールドがあります。

導入されたバージョン:

1.5

メソッドの概要

Object	clone() 新しい Descriptor (Descriptor の複製) を返します。
String[]	getFieldNames() 記述子内のすべてのフィールド名を返します。
String[]	getFields() この記述子に含まれるすべてのフィールドを単一の配列として返します。
Object	getFieldValue(String fieldName) 特定のフィールド名を表す値を返します。
Object[]	getFieldValues(String[] fieldNames) 記述子内のすべてのフィールドの値を Object の配列として返します。
boolean	isValid() すべてのフィールドの有効な値に名前が付与されている場合、true を返します。
void	removeField(String fieldName) 記述子からフィールドを削除します。
void	setField(String fieldName, Object fieldValue) 特定のフィールド名を表す値を設定します。
void	setFields(String[] fieldNames, Object[] fieldValues) リスト内のすべてのフィールドに新しい値 (fieldValue 配列内のインデックスと同じ値) を設定します。

メソッドの詳細

getFieldValue

Object getFieldValue(String fieldName)
                     throws RuntimeOperationsException

特定のフィールド名を表す値を返します。

パラメータ:

fieldName - フィールド名。見つからない場合は null

戻り値:

オブジェクトフィールド値

例外:

RuntimeOperationsException - フィールド名の値が不正である場合

setField

void setField(String fieldName,
              Object fieldValue)
              throws RuntimeOperationsException

特定のフィールド名を表す値を設定します。フィールド名の設定前に妥当性のチェックが行われ、有効でない場合は例外がスローされます。この操作により、既存のフィールドが変更されたり、新しいフィールドが追加されたりします。

パラメータ:

fieldName - 設定されるフィールド名。null や空文字列は使用できない

fieldValue - フィールド名として設定される値。null も可

例外:

RuntimeOperationsException - フィールド名またはフィールド値を表す値が不正である場合

getFields

String[] getFields()

この記述子に含まれるすべてのフィールドを単一の配列として返します。

戻り値:

フィールドの文字配列。形式は fieldName=fieldValue。フィールドの値が String でない場合、toString() メソッドが呼び出される。戻り値は、返される配列内のフィールドの値として使用される。String でないオブジェクト値は括弧で囲まれた形式で表される。記述子が空の場合、空の配列が返される

関連項目:

setFields(java.lang.String[], java.lang.Object[])

getFieldNames

String[] getFieldNames()

記述子内のすべてのフィールド名を返します。

戻り値:

フィールド名から成る文字配列。記述子が空の場合、空の配列が返される

getFieldValues

Object[] getFieldValues(String[] fieldNames)

記述子内のすべてのフィールドの値を Object の配列として返します。返される値の順番は、fieldNames String 配列パラメータの場合と同じになります。

パラメータ:

fieldNames - 値が返されるフィールドの名前から成る文字配列。配列が空の場合、空の配列が返される。配列が null の場合、すべての値が返される。配列内のフィールド名が存在しない場合、対応する配列要素の位置に null が返される

戻り値:

フィールド値から成るオブジェクト配列。記述子が空の場合、空の配列が返される

removeField

void removeField(String fieldName)

記述子からフィールドを削除します。

パラメータ:

fieldName - 削除されるフィールドの文字列名。フィールドが見つからない場合、例外はスローされない

setFields

void setFields(String[] fieldNames,
               Object[] fieldValues)
               throws RuntimeOperationsException

リスト内のすべてのフィールドに新しい値 (fieldValue 配列内のインデックスと同じ値) を設定します。配列サイズは一致している必要があります。フィールド値の設定前に妥当性のチェックが行われ、無効な値の場合は例外がスローされます。配列が空の場合、変更内容は適用されません。

パラメータ:

fieldNames - フィールド名の文字配列。配列および配列要素は null 以外

fieldValues - 対応するフィールド値から成るオブジェクト配列。配列は null 以外。配列要素は null の場合もある

例外:

RuntimeOperationsException - フィールド名またはフィールド値が不正である場合。フィールド名、フィールド値ともに、null は使用できない。配列の長さは一致している必要がある。何らかの理由で記述子の作成に失敗した場合、この例外がスローされる

関連項目:

getFields()

clone

Object clone()
             throws RuntimeOperationsException

新しい Descriptor (Descriptor の複製) を返します。

例外:

RuntimeOperationsException - フィールド名またはフィールド値が不正である場合。何らかの理由で記述子の作成に失敗した場合、この例外がスローされる

isValid

boolean isValid()
                throws RuntimeOperationsException

すべてのフィールドの有効な値に名前が付与されている場合、true を返します。

戻り値:

値が有効な場合は true

例外:

RuntimeOperationsException - 何らかの理由で妥当性チェックに失敗した場合、この例外がスローされる