OpenMBeanParameterInfo (Java Platform SE 8)

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

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インスタンスの文字列表現

バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.

インタフェースOpenMBeanParameterInfo

メソッドのサマリー

メソッドの詳細

getDescription

getName

getOpenType

getDefaultValue

getLegalValues

getMinValue

getMaxValue

hasDefaultValue

hasLegalValues

hasMinValue

hasMaxValue

isValue

equals

hashCode

toString