クラスMBeanOperationInfo

java.lang.Object
javax.management.MBeanFeatureInfo
javax.management.MBeanOperationInfo
すべての実装されたインタフェース:
Serializable, Cloneable, DescriptorRead
直系の既知のサブクラス:
ModelMBeanOperationInfo, OpenMBeanOperationInfoSupport
public class MBeanOperationInfo extends MBeanFeatureInfo implements Cloneable
MBeanによって公開される管理オペレーションを記述します。 このクラスのインスタンスは不変です。 サブクラスは可変ですが、サブクラスの変更は推奨されていません。
導入されたバージョン:
1.5
関連項目:

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final int
    ACTION
    書込みに近いオペレーションであることを示します。MBeanに影響を与えますが、MBeanの情報は返しません。
    static final int
    ACTION_INFO
    読み取りおよび書込みに近いオペレーションであることを示します。MBeanに影響を与えるとともに、MBeanの情報を返します。
    static final int
    INFO
    読取りに近いオペレーションであることを示します。情報を返しますが、状態は変更しません。
    static final int
    UNKNOWN
    オペレーションの影響が不明であるか、またはほかのどの値を使用しても表すことができないことを示します。

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

    description, name
    修飾子と型
    フィールド
    説明
    protected String
    description
    人間が読める形式の機能の説明。
    protected String
    name
    機能の名前。

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

    コンストラクタ
    コンストラクタ
    説明
    MBeanOperationInfo(String description, Method method)
    MBeanOperationInfoオブジェクトを構築します。
    MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact)
    MBeanOperationInfoオブジェクトを構築します。
    MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor)
    MBeanOperationInfoオブジェクトを構築します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    Object
    clone()
    このインスタンスのシャロー・コピーを返します。
    boolean
    equals(Object o)
    このMBeanOperationInfoを別のMBeanOperationInfoと比較します。
    int
    getImpact()
    メソッドの影響(INFO, ACTION, ACTION_INFO, UNKNOWNのいずれか)を返します。
    String
    getReturnType()
    メソッドの戻り値の型を返します。
    MBeanParameterInfo[]
    getSignature()
    このオペレーションのパラメータのリストを返します。

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

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

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

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

  • フィールド詳細

    • INFO

      public static final int INFO
      読取りに近いオペレーションであることを示します。情報を返しますが、状態は変更しません。
      関連項目:

    • ACTION

      public static final int ACTION
      書込みに近いオペレーションであることを示します。MBeanに影響を与えますが、MBeanの情報は返しません。
      関連項目:

    • ACTION_INFO

      public static final int ACTION_INFO
      読み取りおよび書込みに近いオペレーションであることを示します。MBeanに影響を与えるとともに、MBeanの情報を返します。
      関連項目:

    • UNKNOWN

      public static final int UNKNOWN
      オペレーションの影響が不明であるか、またはほかのどの値を使用しても表すことができないことを示します。
      関連項目:

  • コンストラクタの詳細

    • MBeanOperationInfo

      public MBeanOperationInfo(String description, Method method)
      MBeanOperationInfoオブジェクトを構築します。 構築されたオブジェクトのDescriptorには、DescriptorKeyメタ注釈を含むMethodオブジェクト上の注釈が寄与するフィールドが含まれます。
      パラメータ:
      description - 人間が読める形式のオペレーションの説明。
      method - MBeanのオペレーションを記述するjava.lang.reflect.Methodオブジェクト。

    • MBeanOperationInfo

      public MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact)
      MBeanOperationInfoオブジェクトを構築します。
      パラメータ:
      name - メソッドの名前。
      description - 人間が読める形式のオペレーションの説明。
      signature - メソッドのパラメータ(引数)を説明するMBeanParameterInfoオブジェクト。 ゼロ長の配列を指定した場合と同様に、nullになる場合もある。
      type - メソッドの戻り値の型。
      impact - メソッドの影響。INFO、ACTION、ACTION_INFO、UNKNOWNのいずれか。

    • MBeanOperationInfo

      public MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor)
      MBeanOperationInfoオブジェクトを構築します。
      パラメータ:
      name - メソッドの名前。
      description - 人間が読める形式のオペレーションの説明。
      signature - メソッドのパラメータ(引数)を説明するMBeanParameterInfoオブジェクト。 ゼロ長の配列を指定した場合と同様に、nullになる場合もある。
      type - メソッドの戻り値の型。
      impact - メソッドの影響。INFO、ACTION、ACTION_INFO、UNKNOWNのいずれか。
      descriptor - オペレーションの記述子。 nullの場合があり、これは空の記述子と同等。
      スロー:
      IllegalArgumentException - impactがACTION、ACTION_INFO、INFOまたはUNKNOWNのいずれでもない場合。
      導入されたバージョン:
      1.6

  • メソッドの詳細

    • clone

      public Object clone()

      このインスタンスのシャロー・コピーを返します。 クローンは、単にsuper.clone()をコールするだけで取得されるため、Object.clone()によって実装されるデフォルトのネイティブ・シャロー・クローニング・メカニズムをコールします。 内部フィールドについて、これ以上詳細なコピーは作成されません。

      このクラスは不変なので、コピーは主にサブクラスにとって重要な処理となります。

      オーバーライド:
      clone、クラスObject
      戻り値:
      このインスタンスの複製。
      関連項目:

    • getReturnType

      public String getReturnType()
      メソッドの戻り値の型を返します。
      戻り値:
      戻り型。

    • getSignature

      public MBeanParameterInfo[] getSignature()

      このオペレーションのパラメータのリストを返します。 各パラメータはMBeanParameterInfoオブジェクトによって記述されます。

      返される配列は、内部配列のシャロー・コピー、つまりMBeanParameterInfoオブジェクトを参照する内部配列のコピーになります。ただし、参照される各MBeanParameterInfoオブジェクトはコピーされません。

      戻り値:
      MBeanParameterInfoオブジェクトの配列。

    • getImpact

      public int getImpact()
      メソッドの影響(INFO, ACTION, ACTION_INFO, UNKNOWNのいずれか)を返します。
      戻り値:
      影響コード。

    • equals

      public boolean equals(Object o)
      このMBeanOperationInfoを別のMBeanOperationInfoと比較します。
      オーバーライド:
      equals、クラスMBeanFeatureInfo
      パラメータ:
      o - 比較対象のオブジェクト。
      戻り値:
      oがMBeanOperationInfoであり、そのMBeanFeatureInfo.getName()、getReturnType()、MBeanFeatureInfo.getDescription()、getImpact()、MBeanFeatureInfo.getDescriptor()、およびgetSignature()の各値がこのMBeanConstructorInfoのそれらと同等(同一である必要はない)の場合にだけtrue。 要素のペアが等しい場合、2つのシグニチャ配列は等しい。
      関連項目: