ModelMBeanOperationInfo (Java Platform SE 7)

java.lang.Object
- javax.management.MBeanFeatureInfo
- - javax.management.MBeanOperationInfo
  - - javax.management.modelmbean.ModelMBeanOperationInfo

すべての実装されたインタフェース:: Serializable, Cloneable, DescriptorAccess, DescriptorRead

public class ModelMBeanOperationInfo
extends MBeanOperationInfo
implements DescriptorAccess

ModelMBeanOperationInfo オブジェクトは、ModelMBean の管理オペレーションを記述します。これは、関連 Descriptor を持ち、DescriptorAccess インタフェースを実装した MBeanOperationInfo のサブクラスです。

記述子内のフィールドは次のように定義済みですが、この内容に限定されません。この表で型が Number である場合は、Long の 10 進数表現である String を使用することもできます。

名前	型	意味
name	String	オペレーション名。
descriptorType	String	必ず operation。
class	String	メソッドが定義されたクラス (完全修飾)。
role	String	必ず operation、getter、または setter。
targetObject	Object	メソッドはこのオブジェクトに対して実行される。
targetType	String	targetObject のオブジェクト参照型。次のうちのいずれか: ObjectReference、Handle、EJBHandle、IOR、RMIReference。
value	Object	オペレーションのキャッシュ値。
displayName	String	人間が読める形式のオペレーションの表示名。
currencyTimeLimit	Number	キャッシュ値の有効期間。
lastUpdatedTimeStamp	Number	キャッシュ値が設定された時刻。
visibility	Number	1 - 4 の値のうち 1:常に可視 4:ほとんど不可視。
presentationString	String	オペレーションの表現方法を説明するための XML 形式の文字列

デフォルトの記述子は、name、descriptorType、displayName、および role フィールドを設定します。name および displayName フィールドのデフォルト値は、オペレーションの名前です。

注:以前のバージョンの仕様との不整合があるため、currencyTimeLimit にはゼロ以下の値を使用しないようにしてください。キャッシュに入った値が有効でないことを示す場合は、currencyTimeLimit フィールドを省略します。この値が常に有効であることを示す場合は、このフィールドに非常に大きい値を指定します。

このクラスの serialVersionUID は 6532732096650090465L です。

導入されたバージョン:: 1.5
関連項目:: 直列化された形式

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

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

コンストラクタ
コンストラクタと説明
`ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo)` この ModelMBeanOperation オブジェクトから新しい ModelMBeanOperationInfo オブジェクトを構築します。
`ModelMBeanOperationInfo(String description, Method operationMethod)` デフォルトの記述子で ModelMBeanOperationInfo オブジェクトを構築します。
`ModelMBeanOperationInfo(String description, Method operationMethod, Descriptor descriptor)` ModelMBeanOperationInfo オブジェクトを構築します。
`ModelMBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact)` デフォルトの記述子で ModelMBeanOperationInfo オブジェクトを構築します。
`ModelMBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor)` ModelMBeanOperationInfo オブジェクトを構築します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`Object`	`clone()` この ModelMBeanOperationInfo を複製して新しい ModelMBeanOperationInfo を作成し、返します。
`Descriptor`	`getDescriptor()` ModelMBeanOperationInfo に関連付けられた Descriptor のコピーを返します。
`void`	`setDescriptor(Descriptor inDescriptor)` ModelMBeanOperationInfo に関連付けられた Descriptor (完全置換) を設定します。新しい Descriptor が null の場合、関連付けられた Descriptor はデフォルトの記述子に戻ります。
`String`	`toString()` 人間が読める形式の ModelMBeanOperationInfo のコンテンツ全体を含む文字列を返します。

クラス javax.management.MBeanOperationInfo から継承されたメソッド
equals, getImpact, getReturnType, getSignature, hashCode

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

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

- コンストラクタの詳細
  - ModelMBeanOperationInfo
```
public ModelMBeanOperationInfo(String description,
                       Method operationMethod)
```
    デフォルトの記述子で ModelMBeanOperationInfo オブジェクトを構築します。構築されたオブジェクトの Descriptor には、DescriptorKey メタ注釈を含む Method オブジェクト上の注釈が寄与するフィールドが含まれます。
    
    パラメータ:
    operationMethod - MBean オペレーションを記述する java.lang.reflect.Method オブジェクト。
    description - 人間が読める形式のオペレーションの説明。
  - ModelMBeanOperationInfo
```
public ModelMBeanOperationInfo(String description,
                       Method operationMethod,
                       Descriptor descriptor)
```
    ModelMBeanOperationInfo オブジェクトを構築します。構築されたオブジェクトの Descriptor には、DescriptorKey メタ注釈を含む Method オブジェクト上の注釈が寄与するフィールドが含まれます。
    
    パラメータ:
    operationMethod - MBean オペレーションを記述する java.lang.reflect.Method オブジェクト。
    description - 人間が読める形式のオペレーションの説明。
    descriptor - この ModelMBeanOperationInfo インスタンス用として適切なメタデータを含む Descriptor インスタンス。null の場合、デフォルトの記述子が作成される。記述子に displayName フィールドまたは role フィールドが含まれない場合、見つからないフィールドがデフォルト値で追加される。
    
    例外:
    
    RuntimeOperationsException - IllegalArgumentException をラップする。記述子が無効である場合、記述子フィールド name がオペレーション名と等しくない場合、記述子フィールド DescriptorType が operation と等しくない場合、または記述子のオプションフィールド role が存在するが、operation、getter、または setter と等しくない場合。
  - ModelMBeanOperationInfo
```
public ModelMBeanOperationInfo(String name,
                       String description,
                       MBeanParameterInfo[] signature,
                       String type,
                       int impact)
```
    デフォルトの記述子で ModelMBeanOperationInfo オブジェクトを構築します。
    
    パラメータ:
    name - メソッドの名前。
    description - 人間が読める形式のオペレーションの説明。
    signature - メソッドのパラメータ (引数) を記述する MBeanParameterInfo オブジェクト。
    type - メソッドの戻り値の型。
    impact - メソッドの影響。INFO、ACTION、ACTION_INFO、UNKNOWN のいずれか。
  - ModelMBeanOperationInfo
```
public ModelMBeanOperationInfo(String name,
                       String description,
                       MBeanParameterInfo[] signature,
                       String type,
                       int impact,
                       Descriptor descriptor)
```
    ModelMBeanOperationInfo オブジェクトを構築します。
    
    パラメータ:
    name - メソッドの名前。
    description - 人間が読める形式のオペレーションの説明。
    signature - メソッドのパラメータ (引数) を記述する MBeanParameterInfo オブジェクト。
    type - メソッドの戻り値の型。
    impact - メソッドの影響。INFO、ACTION、ACTION_INFO、UNKNOWN のいずれか。
    descriptor - この MBeanOperationInfo インスタンス用として適切なメタデータを含む Descriptor インスタンス。null の場合、デフォルトの記述子が作成される。記述子に displayName フィールドまたは role フィールドが含まれない場合、見つからないフィールドがデフォルト値で追加される。
    
    例外:
    
    RuntimeOperationsException - IllegalArgumentException をラップする。記述子が無効である場合、記述子フィールド name がオペレーション名と等しくない場合、記述子フィールド DescriptorType が operation と等しくない場合、または記述子のオプションフィールド role が存在するが、operation、getter、または setter と等しくない場合。
  - ModelMBeanOperationInfo
```
public ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo)
```
    この ModelMBeanOperation オブジェクトから新しい ModelMBeanOperationInfo オブジェクトを構築します。
    
    パラメータ:
    inInfo - 複製される ModelMBeanOperationInfo
- メソッドの詳細
  - clone
```
public Object clone()
```
    この ModelMBeanOperationInfo を複製して新しい ModelMBeanOperationInfo を作成し、返します。
    
    オーバーライド:
    
    clone、クラス: MBeanOperationInfo
    
    戻り値:
    このインスタンスの複製。
    関連項目:
    Cloneable
  - getDescriptor
```
public Descriptor getDescriptor()
```
    ModelMBeanOperationInfo に関連付けられた Descriptor のコピーを返します。
    
    定義:
    
    getDescriptor、インタフェース: DescriptorRead
    
    オーバーライド:
    
    getDescriptor、クラス: MBeanFeatureInfo
    
    戻り値:
    ModelMBeanOperationInfo オブジェクトに関連付けられた Descriptor。
    関連項目:
    setDescriptor(javax.management.Descriptor)
  - setDescriptor
```
public void setDescriptor(Descriptor inDescriptor)
```
    ModelMBeanOperationInfo に関連付けられた Descriptor (完全置換) を設定します。新しい Descriptor が null の場合、関連付けられた Descriptor はデフォルトの記述子に戻ります。Descriptor の割り当て前には、妥当性検査が行われます。新しい Descriptor が無効である場合、IllegalArgumentException をラップする RuntimeOperationsException がスローされます。
    
    定義:
    
    setDescriptor、インタフェース: DescriptorAccess
    
    パラメータ:
    inDescriptor - ModelMBeanOperation に関連付けられた Descriptor を置換する。
    
    例外:
    
    RuntimeOperationsException - 記述子が無効な場合、IllegalArgumentException をラップする。
    関連項目:
    getDescriptor()
  - toString
```
public String toString()
```
    人間が読める形式の ModelMBeanOperationInfo のコンテンツ全体を含む文字列を返します。
    
    オーバーライド:
    
    toString、クラス: MBeanOperationInfo
    
    戻り値:
    このオブジェクトの文字列表現。

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

クラス ModelMBeanOperationInfo

フィールドのサマリー

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

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

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

メソッドのサマリー

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

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

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

コンストラクタの詳細

ModelMBeanOperationInfo

ModelMBeanOperationInfo

ModelMBeanOperationInfo

ModelMBeanOperationInfo

ModelMBeanOperationInfo

メソッドの詳細

clone

getDescriptor

setDescriptor

toString