Class MBeanOperationInfo

public static final int ACTION

Used to signify that the operation makes some change to the state of the bean (akin to a mutator).

Field Value:

1

public static final int ACTION_INFO

Used to signify that the operation makes some state change to the bean and also returns information.

Field Value:

2

public static final int INFO

Used to signify that the operation merely provides information (akin to an accessor).

Field Value:

0

public static final int UNKNOWN

Used to signify that the behaviour of the operation is unknown.

Field Value:

3

public MBeanOperationInfo(String name,
                          String desc,
                          MBeanParameterInfo[] sig,
                          String type,
                          int impact)

Constructs a @link{MBeanOperationInfo} with the specified name, description, parameter information, return type and impact. A null value for the parameter information is the same as passing in an empty array. A copy of the parameter array is taken, so later changes have no effect.

Parameters:

name - the name of the constructor.

desc - a description of the attribute.

sig - the signature of the method, as a series of MBeanParameterInfo objects, one for each parameter.

type - the return type of the method, as the class name.

impact - the impact of performing the operation.

public MBeanOperationInfo(String desc,
                          Method method)

Constructs a @link{MBeanOperationInfo} with the specified description using the given method. Each parameter is described merely by its type; the name and description are null. The return type and impact of the method are determined from the Method instance.

Parameters:

desc - a description of the attribute.

method - the method.

public Object clone()

Returns a clone of this instance. The clone is created using just the method provided by Object. Thus, the clone is just a shallow clone as returned by that method, and does not contain any deeper cloning based on the subject of this class.

Overrides:

clone in interface Object

Returns:

a clone of this instance.

See Also:

Cloneable

public boolean equals(Object obj)

Compares this feature with the supplied object. This returns true iff the object is an instance of MBeanConstructorInfo, Object.equals() returns true for a comparison of both the name and description of this notification with that of the specified object (performed by the superclass), the return type and impact are equal and the two signature arrays contain the same elements in the same order (but one may be longer than the other).

Overrides:

equals in interface MBeanFeatureInfo

Parameters:

obj - the object to compare.

Returns:

true if the object is a MBeanOperationInfo instance, name.equals(object.getName()), description.equals(object.getDescription()), type.equals(object.getReturnType()), impact == object.getImpact(), and the corresponding elements of the signature arrays are equal.

public int getImpact()

Returns the impact of performing this operation. The value is equal to one of the following:

1. INFO — the method just returns information (akin to an accessor).
2. ACTION — the method just alters the state of the bean, without returning a value (akin to a mutator).
3. ACTION_INFO — the method both makes state changes and returns a value.
4. UNKNOWN — the behaviour of the operation is unknown.

Returns:

the impact of performing the operation.

public String getReturnType()

Returns the return type of the operation, as the class name.

Returns:

the return type.

public MBeanParameterInfo[] getSignature()

Returns the operation's signature, in the form of information on each parameter. Each parameter is described by an instance of MBeanParameterInfo. The returned array is a shallow copy of the array used by this instance, so changing which elements are stored in the array won't affect the array used by this, but changing the actual elements will affect the ones used here.

Returns:

an array of MBeanParameterInfo objects, describing the operation parameters.

public int hashCode()

Returns the hashcode of the operation information as the sum of the hashcode of the superclass, the parameter array, the return type and the impact factor.

Overrides:

hashCode in interface MBeanFeatureInfo

Returns:

the hashcode of the operation information.

public String toString()

Returns a textual representation of this instance. This is constructed using the class name (javax.management.MBeanOperationInfo), the name, description, return type and impact of the operation and the contents of the array of parameters.

As instances of this class are immutable, the return value is computed just once for each instance and reused throughout its life.

Overrides:

toString in interface MBeanFeatureInfo

Returns:

a @link{java.lang.String} instance representing the instance in textual form.