OpenMBeanParameterInfoSupport (Java Platform SE 7)

java.lang.Object
- javax.management.MBeanFeatureInfo
- - javax.management.MBeanParameterInfo
  - - javax.management.openmbean.OpenMBeanParameterInfoSupport

すべての実装されたインタフェース:

Serializable, Cloneable, DescriptorRead, OpenMBeanParameterInfo
```
public class OpenMBeanParameterInfoSupport
extends MBeanParameterInfo
implements OpenMBeanParameterInfo
```
公開 MBean の 1 つ以上のオペレーションまたはコンストラクタで使用されるパラメータを記述します。

導入されたバージョン:

1.5

関連項目:
直列化された形式

フィールドのサマリー
- クラス javax.management.MBeanFeatureInfo から継承されたフィールド
  description, name

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType)` `OpenMBeanParameterInfoSupport` インスタンスを構築します。このインスタンスは、指定された `name`、`openType`、および `description` を使って、公開 MBean のクラスの 1 つ以上のオペレーションまたはコンストラクタで使用するパラメータを記述します。
`OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType, Descriptor descriptor)` `OpenMBeanParameterInfoSupport` インスタンスを構築します。このインスタンスは、指定された `name`、`openType`、`description`、および `descriptor` で、公開 MBean のクラスの 1 つ以上のオペレーションまたはコンストラクタで使用するパラメータを記述します。
`OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue)` `OpenMBeanParameterInfoSupport` インスタンスを構築します。このインスタンスは、指定された `name`、`openType`、`description`、および `defaultValue` を使って、公開 MBean のクラスの 1 つ以上のオペレーションまたはコンストラクタで使用するパラメータを記述します。
`OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue)` オープン MBean のクラスの 1 つ以上のオペレーションまたはコンストラクタで使用されるパラメータを記述する `OpenMBeanParameterInfoSupport` インスタンスを、指定された `name`、`openType`、`description`、`defaultValue`、`minValue`、および `maxValue` を使って構築します。
`OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, T[] legalValues)` `OpenMBeanParameterInfoSupport` インスタンスを構築します。このインスタンスは、指定された `name`、`openType`、`description`、`defaultValue`、および `legalValues` を使って公開 MBean のクラスの 1 つ以上のオペレーションまたはコンストラクタで使用するパラメータを記述します。

メソッドのサマリー

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

クラス javax.management.MBeanParameterInfo から継承されたメソッド
clone, getType

クラス javax.management.MBeanFeatureInfo から継承されたメソッド
getDescription, getDescriptor, getName

クラス java.lang.Object から継承されたメソッド
finalize, getClass, notify, notifyAll, wait, wait, wait

インタフェース javax.management.openmbean.OpenMBeanParameterInfo から継承されたメソッド
getDescription, getName

- コンストラクタの詳細
  - OpenMBeanParameterInfoSupport
```
public OpenMBeanParameterInfoSupport(String name,
                             String description,
                             OpenType<?> openType)
```
    OpenMBeanParameterInfoSupport インスタンスを構築します。このインスタンスは、指定された name、openType、および description を使って、公開 MBean のクラスの 1 つ以上のオペレーションまたはコンストラクタで使用するパラメータを記述します。
    
    パラメータ:
    name - null または空文字列は使用できない。
    description - null または空文字列は使用できない。
    openType - null 以外。
    
    例外:
    
    IllegalArgumentException - name または description が null または空文字列の場合、または openType が null の場合。
  - OpenMBeanParameterInfoSupport
```
public OpenMBeanParameterInfoSupport(String name,
                             String description,
                             OpenType<?> openType,
                             Descriptor descriptor)
```
    OpenMBeanParameterInfoSupport インスタンスを構築します。このインスタンスは、指定された name、openType、description、および descriptor で、公開 MBean のクラスの 1 つ以上のオペレーションまたはコンストラクタで使用するパラメータを記述します。
    
    descriptor には、このクラスの特定のメソッドが返す値を定義するエントリを含めることができます。詳細は、「パッケージの説明」を参照してください。
    
    パラメータ:
    name - null または空文字列は使用できない。
    description - null または空文字列は使用できない。
    openType - null 以外。
    descriptor - パラメータの記述子。null の場合があり、これは空の記述子と同等。
    
    例外:
    
    IllegalArgumentException - name または description が null または空文字列の場合、または openType が null の場合、または「パッケージの説明」に示されているように、記述子のエントリが無効である場合。
    導入されたバージョン:
    
    1.6
  - OpenMBeanParameterInfoSupport
```
public OpenMBeanParameterInfoSupport(String name,
                             String description,
                             OpenType<T> openType,
                             T defaultValue)
                              throws OpenDataException
```
    OpenMBeanParameterInfoSupport インスタンスを構築します。このインスタンスは、指定された name、openType、description、および defaultValue を使って、公開 MBean のクラスの 1 つ以上のオペレーションまたはコンストラクタで使用するパラメータを記述します。
    
    型パラメータ:
    T - defaultValue が null でない場合、指定された openType 用の適正な Java 型が保持されているか確認することをコンパイラに許可する。
    パラメータ:
    name - null または空文字列は使用できない。
    description - null または空文字列は使用できない。
    openType - null 以外。
    defaultValue - このパラメータに指定された openType に対して有効な値でなければならない。ArrayType および TabularType 用にサポートされていないデフォルト値。null の場合、デフォルト値は設定されていないことになる。
    
    例外:
    
    IllegalArgumentException - name または description が null または空文字列の場合、または openType が null の場合。
    
    OpenDataException - defaultValue が指定した openType で有効な値ではない場合、または defaultValue が null ではなく、openType が ArrayType または TabularType である場合。
  - OpenMBeanParameterInfoSupport
```
public OpenMBeanParameterInfoSupport(String name,
                             String description,
                             OpenType<T> openType,
                             T defaultValue,
                             T[] legalValues)
                              throws OpenDataException
```
    OpenMBeanParameterInfoSupport インスタンスを構築します。このインスタンスは、指定された name、openType、description、defaultValue、および legalValues を使って公開 MBean のクラスの 1 つ以上のオペレーションまたはコンストラクタで使用するパラメータを記述します。
    
    legalValues の内容がコピーされます。このため、legalValues により参照される後続の配列変更は、この OpenMBeanParameterInfoSupport インスタンスには影響を及ぼしません。
    
    型パラメータ:
    T - defaultValue および legalValues が null でない場合、指定された openType 用の適正な Java 型が保持されているか確認することをコンパイラに許可する。
    パラメータ:
    name - null または空文字列は使用できない。
    description - null または空文字列は使用できない。
    openType - null 以外。
    defaultValue - このパラメータに指定された openType に対して有効な値でなければならない。ArrayType および TabularType 用にサポートされていないデフォルト値。null の場合、デフォルト値は設定されていないことになる。
    legalValues - 含まれる各値は、このパラメータに指定された openType に対して有効でなければならない。ArrayType および TabularType 用にサポートされていない正当な値。null または空文字列も可能。
    
    例外:
    
    IllegalArgumentException - name または description が null または空文字列の場合、または openType が null の場合。
    
    OpenDataException - defaultValue が指定した openType 用の有効な値ではない場合、legalValues の値が指定した openType で有効でない場合、defaultValue が null でなく、openType が ArrayType または TabularType である場合、または legalValues が null でも空でもなく、openType が ArrayType または TabularType である場合、または legalValues が null でも空でもなく、defaultValue が legalValues に含まれない場合。
  - OpenMBeanParameterInfoSupport
```
public OpenMBeanParameterInfoSupport(String name,
                             String description,
                             OpenType<T> openType,
                             T defaultValue,
                             Comparable<T> minValue,
                             Comparable<T> maxValue)
                              throws OpenDataException
```
    オープン MBean のクラスの 1 つ以上のオペレーションまたはコンストラクタで使用されるパラメータを記述する OpenMBeanParameterInfoSupport インスタンスを、指定された name、openType、description、defaultValue、minValue、および maxValue を使って構築します。値が Comparable の公開型に対してのみ、最大値と最小値を指定できます。
    
    型パラメータ:
    T - defaultValue、minValue、および maxValue が null でない場合、指定された openType 用の適正な Java 型が保持されているか確認することをコンパイラに許可する。
    パラメータ:
    name - null または空文字列は使用できない。
    description - null または空文字列は使用できない。
    openType - null 以外。
    defaultValue - このパラメータに指定された openType に対して有効な値でなければならない。ArrayType および TabularType 用にサポートされていないデフォルト値。null の場合、デフォルト値は設定されていないことになる。
    minValue - このパラメータに指定された openType に対して有効でなければならない。null の場合、最小値は設定されていないことになる。
    maxValue - このパラメータに指定された openType に対して有効でなければならない。null の場合、最大値は設定されていないことになる。
    
    例外:
    
    IllegalArgumentException - name または description が null または空文字列の場合、または openType が null の場合。
    
    OpenDataException - defaultValue、minValue、または maxValue が指定された openType 用の有効な値ではない場合、defaultValue が null ではなく、openType が ArrayType または TabularType である場合、minValue と maxValue の両方が null ではなく、minValue.compareTo(maxValue) > 0 が true である場合、defaultValue と minValue の両方が null ではなく、minValue.compareTo(defaultValue) > 0 が true である場合、または defaultValue と maxValue の両方が null ではなく、defaultValue.compareTo(maxValue) > 0 が true の場合。
- メソッドの詳細
  - getOpenType
```
public OpenType<?> getOpenType()
```
    この OpenMBeanParameterInfoSupport インスタンスによって記述されるパラメータの値の公開型を返します。
    
    定義:
    
    getOpenType、インタフェース: OpenMBeanParameterInfo
    
    戻り値:
    公開型。
  - getDefaultValue
```
public Object getDefaultValue()
```
    この OpenMBeanParameterInfoSupport インスタンスによって記述されるパラメータのデフォルト値が指定されていれば、この値を返します。そうでない場合は null を返します。
    
    定義:
    
    getDefaultValue、インタフェース: OpenMBeanParameterInfo
    
    戻り値:
    デフォルト値。
  - getLegalValues
```
public Set<?> getLegalValues()
```
    この OpenMBeanParameterInfoSupport インスタンスによって記述されるパラメータの正当な値の変更不能な Set が指定されていれば、これを返します。そうでない場合は null を返します。
    
    定義:
    
    getLegalValues、インタフェース: OpenMBeanParameterInfo
    
    戻り値:
    正当な値のセット。
  - getMinValue
```
public Comparable<?> getMinValue()
```
    この OpenMBeanParameterInfoSupport インスタンスによって記述されるパラメータの最小値が指定されていれば、この値を返します。そうでない場合は null を返します。
    
    定義:
    
    getMinValue、インタフェース: OpenMBeanParameterInfo
    
    戻り値:
    最小値。
  - getMaxValue
```
public Comparable<?> getMaxValue()
```
    この OpenMBeanParameterInfoSupport インスタンスによって記述されるパラメータの最大値が指定されていれば、この値を返します。そうでない場合は null を返します。
    
    定義:
    
    getMaxValue、インタフェース: OpenMBeanParameterInfo
    
    戻り値:
    最大値。
  - hasDefaultValue
```
public boolean hasDefaultValue()
```
    この OpenMBeanParameterInfoSupport インスタンスが記述されたパラメータに対して null 以外のデフォルト値を指定する場合は true、そうでない場合は false を返します。
    
    定義:
    
    hasDefaultValue、インタフェース: OpenMBeanParameterInfo
    
    戻り値:
    デフォルト値がある場合は true。
  - hasLegalValues
```
public boolean hasLegalValues()
```
    この OpenMBeanParameterInfoSupport インスタンスが記述されたパラメータに対して null 以外の正当な値のセットを指定する場合は true、そうでない場合は false を返します。
    
    定義:
    
    hasLegalValues、インタフェース: OpenMBeanParameterInfo
    
    戻り値:
    正当な値のセットがある場合は true。
  - hasMinValue
```
public boolean hasMinValue()
```
    この OpenMBeanParameterInfoSupport インスタンスが記述されたパラメータに対して null 以外の最小値を指定する場合は true、そうでない場合は false を返します。
    
    定義:
    
    hasMinValue、インタフェース: OpenMBeanParameterInfo
    
    戻り値:
    最小値がある場合は true。
  - hasMaxValue
```
public boolean hasMaxValue()
```
    この OpenMBeanParameterInfoSupport インスタンスが記述されたパラメータに対して null 以外の最大値を指定する場合は true、そうでない場合は false を返します。
    
    定義:
    
    hasMaxValue、インタフェース: OpenMBeanParameterInfo
    
    戻り値:
    最大値がある場合は true。
  - isValue
```
public boolean isValue(Object obj)
```
    obj が、この OpenMBeanParameterInfo インスタンスで記述されたパラメータに対して有効な値であるかどうかをテストします。
    
    定義:
    
    isValue、インタフェース: OpenMBeanParameterInfo
    
    パラメータ:
    obj - 判定されるオブジェクト。
    
    戻り値:
    obj がこの OpenMBeanParameterInfo インスタンスにより記述されたパラメータで有効な値である場合は true、そうでない場合は false。
  - equals
```
public boolean equals(Object obj)
```
    指定された obj パラメータとこの OpenMBeanParameterInfoSupport インスタンスが等しいかどうかを比較します。
    
    次のすべての条件が満たされている場合に限り、true を返します。
    - obj が null でない
    - obj が OpenMBeanParameterInfo インタフェースも実装している
    - 名前が等しい
    - 公開型が等しい
    - デフォルト値、最小値、最大値、および正当な値が等しい
    これらの条件が満たされていれば、この equals メソッドは、OpenMBeanParameterInfo インタフェースの異なった実装である obj パラメータに対して正常に機能します。
    obj が DescriptorRead も実装する場合、その getDescriptor() メソッドもこのオブジェクトに対するのと同じ値を返す必要があります。
    定義:
    
    equals、インタフェース: OpenMBeanParameterInfo
    
    オーバーライド:
    
    equals、クラス: MBeanParameterInfo
    
    パラメータ:
    obj - この OpenMBeanParameterInfoSupport インスタンスと等しいかどうかを比較するオブジェクト。
    
    戻り値:
    指定されたオブジェクトがこの OpenMBeanParameterInfoSupport インスタンスと等しい場合は true。
    関連項目:
    Object.hashCode()、HashMap
  - hashCode
```
public int hashCode()
```
    この OpenMBeanParameterInfoSupport インスタンスのハッシュコード値を返します。
    
    OpenMBeanParameterInfoSupport インスタンスのハッシュコードは、equals の比較で使用されたすべての情報要素 (その名前、公開型、デフォルト値、最小値、最大値、正当な値、および記述子) のハッシュコードの合計です。
    これにより、Object.hashCode() メソッドの一般規約によって要求される、任意の 2 つの OpenMBeanParameterInfoSupport インスタンス t1 と t2 で、t1.equals(t2) であれば t1.hashCode()==t2.hashCode() となることが保証されます。
    OpenMBeanParameterInfo インタフェースを実装する別のクラスインスタンスが、equals(java.lang.Object) で定義されているように、この OpenMBeanParameterInfoSupport インスタンスと等しくなる場合もあります。しかし、計算方法が異なっているため、ハッシュコードも異なっている可能性があります。
    OpenMBeanParameterInfoSupport インスタンスは不変で、このインスタンスのハッシュコードは、hashCode の最初の呼び出し時に 1 回だけ計算されます。その後の呼び出しには、同じ値が返されます。
    
    定義:
    
    hashCode、インタフェース: OpenMBeanParameterInfo
    
    オーバーライド:
    
    hashCode、クラス: MBeanParameterInfo
    
    戻り値:
    この OpenMBeanParameterInfoSupport インスタンスのハッシュコード値
    関連項目:
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - toString
```
public String toString()
```
    この OpenMBeanParameterInfoSupport インスタンスの文字列表現を返します。
    この文字列表現は、このクラス (javax.management.openmbean.OpenMBeanParameterInfoSupport) の名前、記述されたパラメータの名前と公開型の文字列表現、そのデフォルト値、最小値、最大値、正当な値、およびその記述子の文字列表現で構成されます。
    OpenMBeanParameterInfoSupport インスタンスは不変で、このインスタンスの文字列表現は、toString の最初の呼び出し時に 1 回だけ計算されます。その後の呼び出しには、同じ値が返されます。
    
    定義:
    
    toString、インタフェース: OpenMBeanParameterInfo
    
    オーバーライド:
    
    toString、クラス: MBeanParameterInfo
    
    戻り値:
    この OpenMBeanParameterInfoSupport インスタンスの文字列表現。

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

クラス OpenMBeanParameterInfoSupport

フィールドのサマリー

クラス javax.management.MBeanFeatureInfo から継承されたフィールド

コンストラクタのサマリー

メソッドのサマリー

クラス javax.management.MBeanParameterInfo から継承されたメソッド

クラス javax.management.MBeanFeatureInfo から継承されたメソッド

クラス java.lang.Object から継承されたメソッド

インタフェース javax.management.openmbean.OpenMBeanParameterInfo から継承されたメソッド

コンストラクタの詳細

OpenMBeanParameterInfoSupport

OpenMBeanParameterInfoSupport

OpenMBeanParameterInfoSupport

OpenMBeanParameterInfoSupport

OpenMBeanParameterInfoSupport

メソッドの詳細

getOpenType

getDefaultValue

getLegalValues

getMinValue

getMaxValue

hasDefaultValue

hasLegalValues

hasMinValue

hasMaxValue

isValue

equals

hashCode

toString