JavaTM 2 Platform
Standard Ed. 5.0

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()
          このパラメータのデフォルト値があれば返します。
 String getDescription()
          人間が読める形式で、この OpenMBeanParameterInfo インスタンスによって記述されたパラメータの説明を返します。
 Set getLegalValues()
          このパラメータの正当な値のセットがあれば返します。
 Comparable getMaxValue()
          このパラメータの最大値があれば返します。
 Comparable getMinValue()
          このパラメータの最小値があれば返します。
 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 を返します。

これらの条件が満たされていれば、この equals メソッドは、OpenMBeanParameterInfo インタフェースの異なった実装である obj パラメータに対して正常に機能します。
 

オーバーライド:
クラス Object 内の equals
パラメータ:
obj - この OpenMBeanParameterInfo インスタンスと等しいかどうかを比較するオブジェクト
戻り値:
指定されたオブジェクトがこの OpenMBeanParameterInfo インスタンスと等しい場合は true
関連項目:
Object.hashCode(), Hashtable

hashCode

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

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

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

オーバーライド:
クラス Object 内の hashCode
戻り値:
この OpenMBeanParameterInfo インスタンスのハッシュコード値
関連項目:
Object.equals(java.lang.Object), Hashtable

toString

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

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

オーバーライド:
クラス Object 内の toString
戻り値:
この OpenMBeanParameterInfo インスタンスの文字列表現

JavaTM 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。