public class

MBeanOperationInfo

extends MBeanFeatureInfo
implements Cloneable
java.lang.Object
   ↳ javax.management.MBeanFeatureInfo
     ↳ javax.management.MBeanOperationInfo
Known Direct Subclasses

Class Overview

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

Summary

Constants
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.
int ACTION_INFO Indicates that the operation is both read-like and write-like.
int INFO Indicates that the operation is read-like, it basically returns information.
int UNKNOWN Indicates that the operation has an "unknown" nature.
[Expand]
Inherited Fields
From class javax.management.MBeanFeatureInfo
Public Constructors
MBeanOperationInfo(String description, Method method)
Constructs an MBeanOperationInfo object.
MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact)
Constructs an MBeanOperationInfo object.
MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor)
Constructs an MBeanOperationInfo object.
Public Methods
Object clone()

Returns a shallow clone of this instance.

boolean equals(Object o)
Compare this MBeanOperationInfo to another.
int getImpact()
Returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
String getReturnType()
Returns the type of the method's return value.
MBeanParameterInfo[] getSignature()

Returns the list of parameters for this operation.

int hashCode()
Returns a hash code value for the object.
String toString()
Returns a string representation of the object.
[Expand]
Inherited Methods
From class javax.management.MBeanFeatureInfo
From class java.lang.Object
From interface javax.management.DescriptorRead

Constants

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.

Constant Value: 1 (0x00000001)

public static final int ACTION_INFO

Indicates that the operation is both read-like and write-like.

Constant Value: 2 (0x00000002)

public static final int INFO

Indicates that the operation is read-like, it basically returns information.

Constant Value: 0 (0x00000000)

public static final int UNKNOWN

Indicates that the operation has an "unknown" nature.

Constant Value: 3 (0x00000003)

Public Constructors

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 Method object that contain the DescriptorKey meta-annotation.

Parameters
description A human readable description of the operation.
method The java.lang.reflect.Method object describing the MBean 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.

Public Methods

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.

Returns
  • a clone of this instance.

public boolean equals (Object o)

Compare this MBeanOperationInfo to another.

Parameters
o the object to compare to.
Returns

public int getImpact ()

Returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.

Returns
  • the impact code.

public String getReturnType ()

Returns the type of the method's return value.

Returns
  • the return type.

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.

Returns
  • An array of MBeanParameterInfo objects.

public int 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:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

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.)

Returns
  • a hash code value for this object.

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: 

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
  • a string representation of the object.