モジュール java.management

パッケージ javax.management.openmbean

インタフェースOpenMBeanParameterInfo

既知のすべてのサブインタフェース:

OpenMBeanAttributeInfo

既知のすべての実装クラス:

OpenMBeanAttributeInfoSupport, OpenMBeanParameterInfoSupport

public interface OpenMBeanParameterInfo

公開MBeanの1つ以上のオペレーションまたはコンストラクタで使用されるパラメータを記述します。

このインタフェースは、MBeanParameterInfoクラスと同じメソッドを宣言します。 このインタフェースを実装するクラス(通常OpenMBeanParameterInfoSupport)は、MBeanParameterInfoを拡張する必要があります。

導入されたバージョン:

1.5

メソッドのサマリー

修飾子と型	メソッド	説明
boolean	equals(Object obj)	指定されたobjパラメータとこのOpenMBeanParameterInfoインスタンスが等しいかどうかを比較します。
Object	getDefaultValue()	このパラメータのデフォルト値が指定されている場合はその値を返し、それ以外の場合はnullを返します。
String	getDescription()	このOpenMBeanParameterInfoインスタンスによって記述されるパラメータの、人間が読める説明を返します。
Set<?>	getLegalValues()	このパラメータの有効な値のセット(存在する場合)を返します。それ以外の場合はnullを返します。
Comparable<?>	getMaxValue()	このパラメータの最大値を返します(このパラメータにパラメータがある場合)、それ以外の場合はnullを返します。
Comparable<?>	getMinValue()	このパラメータの最小値を返します(ある場合)。それ以外の場合はnullを返します。
String	getName()	このOpenMBeanParameterInfoインスタンスによって記述されるパラメータの名前を返します。
OpenType<?>	getOpenType()	このOpenMBeanParameterInfoインスタンスによって記述されたパラメータの値の「オープン・タイプ」を返します。
boolean	hasDefaultValue()	このパラメータにデフォルト値が指定されている場合はtrueを返し、それ以外の場合はfalseを返します。
int	hashCode()	このOpenMBeanParameterInfoインスタンスのハッシュ・コード値を返します。
boolean	hasLegalValues()	このパラメータの有効な値のセットが指定された場合はtrueを返し、それ以外の場合はfalseを返します。
boolean	hasMaxValue()	このパラメータに最大値が指定されている場合はtrueを返し、それ以外の場合はfalseを返します。
boolean	hasMinValue()	このパラメータに最小値が指定されている場合はtrueを返し、それ以外の場合はfalseを返します。
boolean	isValue(Object obj)	objが、このOpenMBeanParameterInfoインスタンスで記述されたパラメータに対して有効な値であるかどうかをテストします。
String	toString()	このOpenMBeanParameterInfoインスタンスの文字列表現を返します。

メソッドの詳細

getDescription

String getDescription()

このOpenMBeanParameterInfoインスタンスによって記述されるパラメータの、人間が読める説明を返します。

戻り値:

説明。

getName

String getName()

このOpenMBeanParameterInfoインスタンスによって記述されるパラメータの名前を返します。

戻り値:

名前

getOpenType

OpenType<?> getOpenType()

このOpenMBeanParameterInfoインスタンスによって記述されたパラメータの値の「オープン・タイプ」を返します。

戻り値:

公開型。

getDefaultValue

Object getDefaultValue()

このパラメータのデフォルト値が指定されている場合はその値を返し、それ以外の場合はnullを返します。

戻り値:

デフォルト値。

getLegalValues

Set<?> getLegalValues()

このパラメータの有効な値のセット(存在する場合)を返します。それ以外の場合はnullを返します。

戻り値:

正当な値のセット。

getMinValue

Comparable<?> getMinValue()

このパラメータの最小値を返します(ある場合)。それ以外の場合はnullを返します。

戻り値:

最小値。

getMaxValue

Comparable<?> getMaxValue()

このパラメータの最大値を返します(このパラメータにパラメータがある場合)、それ以外の場合はnullを返します。

戻り値:

最大値。

hasDefaultValue

boolean hasDefaultValue()

このパラメータにデフォルト値が指定されている場合はtrueを返し、それ以外の場合はfalseを返します。

戻り値:

デフォルト値がある場合はtrue。

hasLegalValues

boolean hasLegalValues()

このパラメータの有効な値のセットが指定された場合はtrueを返し、それ以外の場合はfalseを返します。

戻り値:

正当な値のセットがある場合はtrue。

hasMinValue

boolean hasMinValue()

このパラメータに最小値が指定されている場合はtrueを返し、それ以外の場合はfalseを返します。

戻り値:

最小値がある場合はtrue。

hasMaxValue

boolean hasMaxValue()

このパラメータに最大値が指定されている場合はtrueを返し、それ以外の場合はfalseを返します。

戻り値:

最大値がある場合はtrue。

isValue

boolean isValue(Object obj)

objが、このOpenMBeanParameterInfoインスタンスで記述されたパラメータに対して有効な値であるかどうかをテストします。

パラメータ:

obj - 判定されるオブジェクト。

戻り値:

objがこのOpenMBeanParameterInfoインスタンスにより記述されたパラメータで有効な値である場合はtrue、そうでない場合はfalse。

equals

boolean equals(Object obj)

指定されたobjパラメータとこのOpenMBeanParameterInfoインスタンスが等しいかどうかを比較します。

次のすべての条件が満たされている場合に限り、trueを返します。

• objがnullでない
• objがOpenMBeanParameterInfoインタフェースも実装している
• 名前が等しい
• 公開型が等しい
• デフォルト値、最小値、最大値、および正当な値が等しい

これにより、このequalsメソッドは、OpenMBeanParameterInfoインタフェースの異なる実装であるobjパラメータに対して適切に機能します。

オーバーライド:

equals、クラスObject

パラメータ:

obj - このOpenMBeanParameterInfoインスタンスと等しいかどうかを比較するオブジェクト。

戻り値:

指定されたオブジェクトがこのOpenMBeanParameterInfoインスタンスと等しい場合はtrue。

関連項目:

• Object.hashCode()
• HashMap

hashCode

int hashCode()

このOpenMBeanParameterInfoインスタンスのハッシュ・コード値を返します。

OpenMBeanParameterInfoインスタンスのハッシュ・コードは、equalsの比較で使用されたすべての情報要素(その名前、公開型、デフォルト値、最小値、最大値、および正当な値)のハッシュ・コードの合計です。

これにより、Object.hashCode()メソッドの一般規約によって要求される、任意の2つのOpenMBeanParameterInfoインスタンスt1とt2で、t1.equals(t2)であればt1.hashCode()==t2.hashCode()となることが保証されます。

オーバーライド:

hashCode、クラスObject

戻り値:

このOpenMBeanParameterInfoインスタンスのハッシュ・コード値

関連項目:

• Object.equals(java.lang.Object)
• System.identityHashCode(java.lang.Object)

toString

String toString()

このOpenMBeanParameterInfoインスタンスの文字列表現を返します。

この文字列表現は、このクラス(javax.management.openmbean.OpenMBeanParameterInfo)の名前、記述されたパラメータの名前と公開型の文字列表現、さらにそのデフォルト値、最小値、最大値、および正当な値の文字列表現で構成されます。

オーバーライド:

toString、クラスObject

戻り値:

このOpenMBeanParameterInfoインスタンスの文字列表現