- 既知のすべてのサブインタフェース:
OpenMBeanAttributeInfo
- 既知のすべての実装クラス:
OpenMBeanAttributeInfoSupport
,OpenMBeanParameterInfoSupport
public interface OpenMBeanParameterInfo
公開MBeanの1つ以上のオペレーションまたはコンストラクタで使用されるパラメータを記述します。
このインタフェースは、MBeanParameterInfo
クラスと同じメソッドを宣言します。 このインタフェースを実装するクラス(通常OpenMBeanParameterInfoSupport
)は、MBeanParameterInfo
を拡張する必要があります。
- 導入されたバージョン:
- 1.5
-
メソッドのサマリー
修飾子と型メソッド説明boolean
指定されたobjパラメータとこのOpenMBeanParameterInfo
インスタンスが等しいかどうかを比較します。このパラメータのデフォルト値が指定されている場合はその値を返し、それ以外の場合はnull
を返します。このOpenMBeanParameterInfo
インスタンスによって記述されるパラメータの、人間が読める説明を返します。Set<?>
このパラメータの有効な値のセット(存在する場合)を返します。それ以外の場合はnull
を返します。Comparable<?>
このパラメータの最大値を返します(このパラメータにパラメータがある場合)、それ以外の場合はnull
を返します。Comparable<?>
このパラメータの最小値を返します(ある場合)。それ以外の場合はnull
を返します。getName()
このOpenMBeanParameterInfo
インスタンスによって記述されるパラメータの名前を返します。OpenType<?>
このOpenMBeanParameterInfo
インスタンスによって記述されたパラメータの値の「オープン・タイプ」を返します。boolean
このパラメータにデフォルト値が指定されている場合はtrue
を返し、それ以外の場合はfalse
を返します。int
hashCode()
このOpenMBeanParameterInfo
インスタンスのハッシュ・コード値を返します。boolean
このパラメータの有効な値のセットが指定された場合はtrue
を返し、それ以外の場合はfalse
を返します。boolean
このパラメータに最大値が指定されている場合はtrue
を返し、それ以外の場合はfalse
を返します。boolean
このパラメータに最小値が指定されている場合はtrue
を返し、それ以外の場合はfalse
を返します。boolean
objが、このOpenMBeanParameterInfo
インスタンスで記述されたパラメータに対して有効な値であるかどうかをテストします。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パラメータに対して適切に機能します。
-
hashCode
int hashCode()このOpenMBeanParameterInfo
インスタンスのハッシュ・コード値を返します。OpenMBeanParameterInfo
インスタンスのハッシュ・コードは、equals
の比較で使用されたすべての情報要素(その名前、公開型、デフォルト値、最小値、最大値、および正当な値)のハッシュ・コードの合計です。これにより、
Object.hashCode()
メソッドの一般規約によって要求される、任意の2つのOpenMBeanParameterInfo
インスタンスt1
とt2
で、t1.equals(t2)
であればt1.hashCode()==t2.hashCode()
となることが保証されます。 -
toString
String toString()このOpenMBeanParameterInfo
インスタンスの文字列表現を返します。この文字列表現は、このクラス(
javax.management.openmbean.OpenMBeanParameterInfo
)の名前、記述されたパラメータの名前と公開型の文字列表現、さらにそのデフォルト値、最小値、最大値、および正当な値の文字列表現で構成されます。
-