概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
JavaTM Platform
Standard Ed. 6
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド

javax.management.modelmbean
クラス ModelMBeanOperationInfo

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 のサブクラスです。 

 記述子内のフィールドは以下のように定義済みですが、この内容に限定されません。 
 name           :オペレーション名 
 descriptorType :必ず operation    
 class          :メソッドが定義されたクラス (完全修飾)  
 role           :必ず operation、getter、または setter
 targetObject   :メソッドはこのオブジェクトに対して実行される          
 targetType     :targetObject のオブジェクト参照型。ObjectReference、Handle、EJBHandle、IOR、RMIReference のいずれか
 value          :オペレーション用としてキャッシュされた値                   
 currencyTimeLimit :キャッシュ値の有効期間               
 lastUpdatedTimeStamp :キャッシュ値が設定された時刻                
 visibility     :1 〜 4 の値のうち 1:常に可視 4:ほとんど不可視 
 presentationString :オペレーションの表現方法を説明するための XML 形式の文字列
デフォルトの記述子は、name、descriptorType、displayName、および role フィールドを設定します。

注: 以前のバージョンの仕様との不整合があるため、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 (完全置換) を設定します。
 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 フィールドを含まない記述子には、 デフォルト値の 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 フィールドを含まない記述子には、 デフォルト値の 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 を作成し、返します。

オーバーライド:
クラス MBeanOperationInfo 内の clone
戻り値:
このインスタンスの複製
関連項目:
Cloneable

getDescriptor

public Descriptor getDescriptor()
ModelMBeanOperationInfo に関連付けられた Descriptor のコピーを返します。

定義:
インタフェース DescriptorRead 内の getDescriptor
オーバーライド:
クラス MBeanFeatureInfo 内の getDescriptor
戻り値:
ModelMBeanOperationInfo オブジェクトに 関連付けられた Descriptor
関連項目:
setDescriptor(javax.management.Descriptor)

setDescriptor

public void setDescriptor(Descriptor inDescriptor)
ModelMBeanOperationInfo に関連付けられた Descriptor (完全置換) を設定します。新しい Descriptor が null の場合、関連 Descriptor はデフォルトの記述子に戻ります。Descriptor の割り当て前には、妥当性検査が行われます。新しい Descriptor が無効である場合、IllegalArgumentException をラップする RuntimeOperationsException がスローされます。

定義:
インタフェース DescriptorAccess 内の setDescriptor
パラメータ:
inDescriptor - ModelMBeanOperation に関連付けられた Descriptor を 置換する
例外:
RuntimeOperationsException - 無効な Descriptor の IllegalArgumentException をラップする
関連項目:
getDescriptor()

toString

public String toString()
人間が読める形式の ModelMBeanOperationInfo のコンテンツ全体を含む文字列を返します。

オーバーライド:
クラス MBeanOperationInfo 内の toString
戻り値:
このオブジェクトの文字列表現
概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
JavaTM Platform
Standard Ed. 6
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド
バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。