Home » openjdk-7 » javax » management » [javadoc | source]
javax.management
public class: MBeanOperationInfo [javadoc | source]
java.lang.Object
   javax.management.MBeanFeatureInfo
      javax.management.MBeanOperationInfo

All Implemented Interfaces:
    Cloneable, DescriptorRead, Serializable

Direct Known Subclasses:
    ModelMBeanOperationInfo, OpenMBeanOperationInfoSupport

Describes a management operation exposed by an MBean. Instances of this class are immutable. Subclasses may be mutable but this is not recommended.
Field Summary
static final  long serialVersionUID     
static final  MBeanOperationInfo[] NO_OPERATIONS     
public static final  int INFO    Indicates that the operation is read-like: it returns information but does not change any state. 
public static final  int ACTION    Indicates that the operation is write-like: it has an effect but does not return any information from the MBean. 
public static final  int ACTION_INFO    Indicates that the operation is both read-like and write-like: it has an effect, and it also returns information from the MBean. 
public static final  int UNKNOWN    Indicates that the impact of the operation is unknown or cannot be expressed using one of the other values. 
Fields inherited from javax.management.MBeanFeatureInfo:
serialVersionUID,  name,  description
Constructor:
 public MBeanOperationInfo(String description,
    Method method) 
    Constructs an MBeanOperationInfo object. The Descriptor of the constructed object will include fields contributed by any annotations on the {@code Method} object that contain the DescriptorKey meta-annotation.
    Parameters:
    method - The java.lang.reflect.Method object describing the MBean operation.
    description - A human readable description of the operation.
 public MBeanOperationInfo(String name,
    String description,
    MBeanParameterInfo[] signature,
    String type,
    int impact) 
    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 .
 public MBeanOperationInfo(String name,
    String description,
    MBeanParameterInfo[] signature,
    String type,
    int impact,
    Descriptor descriptor) 
    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 .
    descriptor - The descriptor for the operation. This may be null which is equivalent to an empty descriptor.
    since: 1.6 -
Method from javax.management.MBeanOperationInfo Summary:
clone,   equals,   getImpact,   getReturnType,   getSignature,   hashCode,   parameters,   toString
Methods from javax.management.MBeanFeatureInfo:
equals,   getDescription,   getDescriptor,   getName,   hashCode
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.management.MBeanOperationInfo Detail:
 public 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.

 public boolean equals(Object o) 
    Compare this MBeanOperationInfo to another.
 public int getImpact() 
    Returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
 public String getReturnType() 
    Returns the type of the method's return value.
 public 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.

 public int hashCode() 
 static MBeanParameterInfo[] parameters(Class<?>[] classes,
    Annotation[][] annots) 
 public String toString()