javax.management
Class MBeanOperationInfo

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.management.MBeanFeatureInfo sample code for javax.management.MBeanFeatureInfo definition code for javax.management.MBeanFeatureInfo 
      extended by javax.management.MBeanOperationInfo
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable
Direct Known Subclasses:
ModelMBeanOperationInfo sample code for javax.management.modelmbean.ModelMBeanOperationInfo definition code for javax.management.modelmbean.ModelMBeanOperationInfo , OpenMBeanOperationInfoSupport sample code for javax.management.openmbean.OpenMBeanOperationInfoSupport definition code for javax.management.openmbean.OpenMBeanOperationInfoSupport

public class MBeanOperationInfo
extends MBeanFeatureInfo sample code for javax.management.MBeanFeatureInfo definition code for javax.management.MBeanFeatureInfo
implements Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable

Describes a management operation exposed by an MBean. Instances of this class are immutable. Subclasses may be mutable but this is not recommended.

Since:
1.5
See Also:
Serialized Form

Field Summary
static int ACTION sample code for javax.management.MBeanOperationInfo.ACTION definition code for javax.management.MBeanOperationInfo.ACTION
          Indicates that the operation is a write-like, and would modify the MBean in some way, typically by writing some value or changing a configuration.
static int ACTION_INFO sample code for javax.management.MBeanOperationInfo.ACTION_INFO definition code for javax.management.MBeanOperationInfo.ACTION_INFO
          Indicates that the operation is both read-like and write-like.
static int INFO sample code for javax.management.MBeanOperationInfo.INFO definition code for javax.management.MBeanOperationInfo.INFO
          Indicates that the operation is read-like, it basically returns information.
static int UNKNOWN sample code for javax.management.MBeanOperationInfo.UNKNOWN definition code for javax.management.MBeanOperationInfo.UNKNOWN
          Indicates that the operation has an "unknown" nature.
 
Fields inherited from class javax.management.MBeanFeatureInfo sample code for javax.management.MBeanFeatureInfo definition code for javax.management.MBeanFeatureInfo
description sample code for javax.management.MBeanFeatureInfo.description definition code for javax.management.MBeanFeatureInfo.description , name sample code for javax.management.MBeanFeatureInfo.name definition code for javax.management.MBeanFeatureInfo.name
 
Constructor Summary
MBeanOperationInfo sample code for javax.management.MBeanOperationInfo.MBeanOperationInfo(java.lang.String, java.lang.reflect.Method) definition code for javax.management.MBeanOperationInfo.MBeanOperationInfo(java.lang.String, java.lang.reflect.Method) (String sample code for java.lang.String definition code for java.lang.String  description, Method sample code for java.lang.reflect.Method definition code for java.lang.reflect.Method  method)
          Constructs an MBeanOperationInfo object.
MBeanOperationInfo sample code for javax.management.MBeanOperationInfo.MBeanOperationInfo(java.lang.String, java.lang.String, javax.management.MBeanParameterInfo[], java.lang.String, int) definition code for javax.management.MBeanOperationInfo.MBeanOperationInfo(java.lang.String, java.lang.String, javax.management.MBeanParameterInfo[], java.lang.String, int) (String sample code for java.lang.String definition code for java.lang.String  name, String sample code for java.lang.String definition code for java.lang.String  description, MBeanParameterInfo sample code for javax.management.MBeanParameterInfo definition code for javax.management.MBeanParameterInfo [] signature, String sample code for java.lang.String definition code for java.lang.String  type, int impact)
          Constructs an MBeanOperationInfo object.
 
Method Summary
 Object sample code for java.lang.Object definition code for java.lang.Object clone sample code for javax.management.MBeanOperationInfo.clone() definition code for javax.management.MBeanOperationInfo.clone() ()
          Returns a shallow clone of this instance.
 boolean equals sample code for javax.management.MBeanOperationInfo.equals(java.lang.Object) definition code for javax.management.MBeanOperationInfo.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  o)
          Compare this MBeanOperationInfo to another.
 int getImpact sample code for javax.management.MBeanOperationInfo.getImpact() definition code for javax.management.MBeanOperationInfo.getImpact() ()
          Returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
 String sample code for java.lang.String definition code for java.lang.String getReturnType sample code for javax.management.MBeanOperationInfo.getReturnType() definition code for javax.management.MBeanOperationInfo.getReturnType() ()
          Returns the type of the method's return value.
 MBeanParameterInfo sample code for javax.management.MBeanParameterInfo definition code for javax.management.MBeanParameterInfo [] getSignature sample code for javax.management.MBeanOperationInfo.getSignature() definition code for javax.management.MBeanOperationInfo.getSignature() ()
          Returns the list of parameters for this operation.
 int hashCode sample code for javax.management.MBeanOperationInfo.hashCode() definition code for javax.management.MBeanOperationInfo.hashCode() ()
          Returns a hash code value for the object.
 
Methods inherited from class javax.management.MBeanFeatureInfo sample code for javax.management.MBeanFeatureInfo definition code for javax.management.MBeanFeatureInfo
getDescription sample code for javax.management.MBeanFeatureInfo.getDescription() definition code for javax.management.MBeanFeatureInfo.getDescription() , getName sample code for javax.management.MBeanFeatureInfo.getName() definition code for javax.management.MBeanFeatureInfo.getName()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

INFO sample code for javax.management.MBeanOperationInfo.INFO

public static final int INFO
Indicates that the operation is read-like, it basically returns information.

See Also:
Constant Field Values

ACTION sample code for javax.management.MBeanOperationInfo.ACTION

public static final int ACTION
Indicates that the operation is a write-like, and would modify the MBean in some way, typically by writing some value or changing a configuration.

See Also:
Constant Field Values

ACTION_INFO sample code for javax.management.MBeanOperationInfo.ACTION_INFO

public static final int ACTION_INFO
Indicates that the operation is both read-like and write-like.

See Also:
Constant Field Values

UNKNOWN sample code for javax.management.MBeanOperationInfo.UNKNOWN

public static final int UNKNOWN
Indicates that the operation has an "unknown" nature.

See Also:
Constant Field Values
Constructor Detail

MBeanOperationInfo sample code for javax.management.MBeanOperationInfo(java.lang.String, java.lang.reflect.Method) definition code for javax.management.MBeanOperationInfo(java.lang.String, java.lang.reflect.Method)

public MBeanOperationInfo(String sample code for java.lang.String definition code for java.lang.String  description,
                          Method sample code for java.lang.reflect.Method definition code for java.lang.reflect.Method  method)
                   throws IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException 
Constructs an MBeanOperationInfo object.

Parameters:
method - The java.lang.reflect.Method object describing the MBean operation.
description - A human readable description of the operation.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException

MBeanOperationInfo sample code for javax.management.MBeanOperationInfo(java.lang.String, java.lang.String, javax.management.MBeanParameterInfo[], java.lang.String, int) definition code for javax.management.MBeanOperationInfo(java.lang.String, java.lang.String, javax.management.MBeanParameterInfo[], java.lang.String, int)

public MBeanOperationInfo(String sample code for java.lang.String definition code for java.lang.String  name,
                          String sample code for java.lang.String definition code for java.lang.String  description,
                          MBeanParameterInfo sample code for javax.management.MBeanParameterInfo definition code for javax.management.MBeanParameterInfo [] signature,
                          String sample code for java.lang.String definition code for java.lang.String  type,
                          int impact)
                   throws IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException 
Constructs an MBeanOperationInfo object.

Parameters:
name - The name of the method.
description - A human readable description of the operation.
signature - MBeanParameterInfo objects describing the parameters(arguments) of the method. This may be null with the same effect as a zero-length array.
type - The type of the method's return value.
impact - The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException
Method Detail

clone sample code for javax.management.MBeanOperationInfo.clone() definition code for javax.management.MBeanOperationInfo.clone()

public Object sample code for java.lang.Object definition code for java.lang.Object  clone()

Returns a shallow clone of this instance. The clone is obtained by simply calling super.clone(), thus calling the default native shallow cloning mechanism implemented by Object.clone(). No deeper cloning of any internal field is made.

Since this class is immutable, cloning is chiefly of interest to subclasses.

Overrides:
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a clone of this instance.
See Also:
Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable

getReturnType sample code for javax.management.MBeanOperationInfo.getReturnType() definition code for javax.management.MBeanOperationInfo.getReturnType()

public String sample code for java.lang.String definition code for java.lang.String  getReturnType()
Returns the type of the method's return value.

Returns:
the return type.

getSignature sample code for javax.management.MBeanOperationInfo.getSignature() definition code for javax.management.MBeanOperationInfo.getSignature()

public MBeanParameterInfo sample code for javax.management.MBeanParameterInfo definition code for javax.management.MBeanParameterInfo [] getSignature()

Returns the list of parameters for this operation. Each parameter is described by an MBeanParameterInfo object.

The returned array is a shallow copy of the internal array, which means that it is a copy of the internal array of references to the MBeanParameterInfo objects but that each referenced MBeanParameterInfo object is not copied.

Returns:
An array of MBeanParameterInfo objects.

getImpact sample code for javax.management.MBeanOperationInfo.getImpact() definition code for javax.management.MBeanOperationInfo.getImpact()

public int getImpact()
Returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.

Returns:
the impact code.

equals sample code for javax.management.MBeanOperationInfo.equals(java.lang.Object) definition code for javax.management.MBeanOperationInfo.equals(java.lang.Object)

public boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  o)
Compare this MBeanOperationInfo to another.

Overrides:
equals sample code for javax.management.MBeanFeatureInfo.equals(java.lang.Object) definition code for javax.management.MBeanFeatureInfo.equals(java.lang.Object) in class MBeanFeatureInfo sample code for javax.management.MBeanFeatureInfo definition code for javax.management.MBeanFeatureInfo
Parameters:
o - the object to compare to.
Returns:
true iff o is an MBeanOperationInfo such that its MBeanFeatureInfo.getName() sample code for javax.management.MBeanFeatureInfo.getName() definition code for javax.management.MBeanFeatureInfo.getName() , getReturnType() sample code for javax.management.MBeanOperationInfo.getReturnType() definition code for javax.management.MBeanOperationInfo.getReturnType() , MBeanFeatureInfo.getDescription() sample code for javax.management.MBeanFeatureInfo.getDescription() definition code for javax.management.MBeanFeatureInfo.getDescription() , getImpact() sample code for javax.management.MBeanOperationInfo.getImpact() definition code for javax.management.MBeanOperationInfo.getImpact() , and getSignature() sample code for javax.management.MBeanOperationInfo.getSignature() definition code for javax.management.MBeanOperationInfo.getSignature() values are equal (not necessarily identical) to those of this MBeanConstructorInfo. Two signature arrays are equal if their elements are pairwise equal.
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

hashCode sample code for javax.management.MBeanOperationInfo.hashCode() definition code for javax.management.MBeanOperationInfo.hashCode()

public int hashCode()
Description copied from class: Object sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Overrides:
hashCode sample code for javax.management.MBeanFeatureInfo.hashCode() definition code for javax.management.MBeanFeatureInfo.hashCode() in class MBeanFeatureInfo sample code for javax.management.MBeanFeatureInfo definition code for javax.management.MBeanFeatureInfo
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable