クラスOpenMBeanParameterInfoSupport

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
関連項目:

  • フィールドのサマリー

    クラスで宣言されたフィールド MBeanFeatureInfo

    description, name
    修飾子と型
    フィールド
    説明
    protected String
    description
    人間が読める形式の機能の説明。
    protected String
    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つ以上のオペレーションまたはコンストラクタで使用するパラメータを記述します。
     <T> 
    OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue)
    OpenMBeanParameterInfoSupportインスタンスを構築します。このインスタンスは、指定されたname、openType、description、および defaultValueを使って、公開MBeanのクラスの1つ以上のオペレーションまたはコンストラクタで使用するパラメータを記述します。
     <T> 
    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を使って構築します。
     <T> 
    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インスタンスの文字列表現を返します。

    クラスで宣言されたメソッド MBeanParameterInfo

    clone, getType
    修飾子と型
    メソッド
    説明
    Object
    clone()
    このインスタンスのシャロー・コピーを返します。
    String
    getType()
    データの型またはクラス名を返します。

    クラスで宣言されたメソッド MBeanFeatureInfo

    getDescription, getDescriptor, getName
    修飾子と型
    メソッド
    説明
    String
    getDescription()
    人間が読める形式の機能の説明を返します。
    Descriptor
    getDescriptor()
    機能の記述子を返します。
    String
    getName()
    機能の名前を返します。

    クラスオブジェクトで宣言されたメソッド

    finalize, getClass, notify, notifyAll, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

    インタフェースで宣言されたメソッド OpenMBeanParameterInfo

    getDescription, getName
    修飾子と型
    メソッド
    説明
    String
    getDescription()
    このOpenMBeanParameterInfoインスタンスによって記述されるパラメータの、人間が読める説明を返します。
    String
    getName()
    このOpenMBeanParameterInfoインスタンスによって記述されるパラメータの名前を返します。

  • コンストラクタの詳細

    • 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 <T> 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 <T> 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の1つの値が指定された openTypeに対して無効であるか、defaultValueがnullでなく、 openTypeがArrayTypeまたはTabularTypeであるか、またはlegalValuesがArrayTypeまたはTabularType、またはlegalValuesはnullでなく、空ではなく、 defaultValueはlegalValuesに含まれていません。

    • OpenMBeanParameterInfoSupport

      public <T> 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の有効な値ではない、または非ヌルとopenTypeがdefaultValueある場合ArrayType又は TabularType、または両方minValueあり、非ヌルとminValue.compareTo(maxValue) > 0 true、または両方defaultValue maxValueでありされminValueあります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。
      関連項目:

    • hashCode

      public int hashCode()

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

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

      これにより、t1.equals(t2)は、メソッドObject.hashCode()の一般契約によって要求されるように、任意の2つの OpenMBeanParameterInfoSupportインスタンスt1および t2の t1.hashCode()==t2.hashCode()を意味します。

      OpenMBeanParameterInfoインタフェースを実装する別のクラス・インスタンスが、equals(java.lang.Object)で定義されているように、このOpenMBeanParameterInfoSupportインスタンスと等しくなる場合もあります。しかし、計算方法が異なっているため、ハッシュ・コードも異なっている可能性があります。

      OpenMBeanParameterInfoSupportインスタンスは不変で、このインスタンスのハッシュ・コードは、hashCodeの最初の呼出し時に1回だけ計算されます。その後の呼出しには、同じ値が返されます。

      定義:
      hashCode、インタフェースOpenMBeanParameterInfo
      オーバーライド:
      hashCode、クラスObject
      戻り値:
      この OpenMBeanParameterInfoSupportインスタンスのハッシュ・コード値
      関連項目:

    • toString

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

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

      OpenMBeanParameterInfoSupportインスタンスは不変で、このインスタンスの文字列表現は、toStringの最初の呼出し時に1回だけ計算されます。その後の呼出しには、同じ値が返されます。

      定義:
      toString、インタフェースOpenMBeanParameterInfo
      オーバーライド:
      toString、クラスObject
      戻り値:
      このOpenMBeanParameterInfoSupportインスタンスの文字列表現。