javax.management
Class MBeanOperationInfo

java.lang.Object
  |
  +--javax.management.MBeanFeatureInfo
        |
        +--javax.management.MBeanOperationInfo

Direct Known Subclasses:

ModelMBeanOperationInfo, OpenMBeanOperationInfo

public class MBeanOperationInfo

extends MBeanFeatureInfo

implements java.io.Serializable, java.lang.Cloneable

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

See Also:

Serialized Form

Field Summary

static int	ACTION Indicates that the operation is a write-like in nature, and would modify the MBean in some way, typically by writing some value or changing a configuration.
static int	ACTION_INFO Indicates that the operation is both read-like and write-like.
static int	INFO Indicates that the operation is a read-like in nature, it basically returns some information.
(package private) static MBeanOperationInfo[]	NO_OPERATIONS
static int	UNKNOWN Indicates that the operation has an "unknown" nature.

Fields inherited from class javax.management.MBeanFeatureInfo

description, name

Constructor Summary

MBeanOperationInfo(java.lang.String description, java.lang.reflect.Method method)
Constructs an MBeanOperationInfo object.

MBeanOperationInfo(java.lang.String name, java.lang.String description, MBeanParameterInfo[] signature, java.lang.String type, int impact)
Constructs an MBeanOperationInfo object.

Method Summary

java.lang.Object	clone() Creates and returns a copy of this object.
boolean	equals(java.lang.Object obj) Compare this MBeanOperationInfo to another.
int	getImpact() Returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
java.lang.String	getReturnType() Returns the type of the method's return value.
MBeanParameterInfo[]	getSignature() Returns the list of parameters for this operation.
int	hashCode() Returns the hash code value for this instance.
java.lang.String	toString() Returns a human readable version of the MBeanOperationInfo instance

Methods inherited from class javax.management.MBeanFeatureInfo

getDescription, getName

Methods inherited from class java.lang.Object

, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ACTION

public static final int ACTION

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

ACTION_INFO

public static final int ACTION_INFO

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

INFO

public static final int INFO

Indicates that the operation is a read-like in nature, it basically returns some information.

UNKNOWN

public static final int UNKNOWN

Indicates that the operation has an "unknown" nature.

NO_OPERATIONS

static final MBeanOperationInfo[] NO_OPERATIONS

Constructor Detail

MBeanOperationInfo

public MBeanOperationInfo(java.lang.String description,
                          java.lang.reflect.Method method)
                   throws 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:

java.lang.IllegalArgumentException - if the name of method is not a valid Java identifier, or if the name of its return type or one of its parameter types is not a syntactically legal Java type name. Java reserved words are not considered illegal here. If method comes from a class compiled from Java, this exception cannot happen.

MBeanOperationInfo

public MBeanOperationInfo(java.lang.String name,
                          java.lang.String description,
                          MBeanParameterInfo[] signature,
                          java.lang.String type,
                          int impact)
                   throws 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:

java.lang.IllegalArgumentException - if name is not a valid Java identifier or if type is not a syntactically legal Java type name. Java reserved words are not considered illegal here.

Method Detail

getImpact

public int getImpact()

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

Returns:

This returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.

getSignature

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.

getReturnType

public java.lang.String getReturnType()

Returns the type of the method's return value.

Returns:

the return type.

clone

public java.lang.Object clone()

Creates and returns a copy of this object.

Overrides:

clone in class java.lang.Object

Returns:

A duplicate copy of this object is created

equals

public boolean equals(java.lang.Object obj)

Compare this MBeanOperationInfo to another.

Overrides:

equals in class MBeanFeatureInfo

Parameters:

o - the object to compare to.

Returns:

true iff o is an MBeanOperationInfo such that its MBeanFeatureInfo.getName(), getReturnType(), MBeanFeatureInfo.getDescription(), getImpact(), and getSignature() values are equal (not necessarily identical) to those of this MBeanConstructorInfo. Two signature arrays are equal if their elements are pairwise equal.

hashCode

public int hashCode()

Returns the hash code value for this instance.

Overrides:

hashCode in class MBeanFeatureInfo

Returns:

hashCode for this instance

toString

public java.lang.String toString()

Returns a human readable version of the MBeanOperationInfo instance

Overrides:

toString in class MBeanFeatureInfo

Returns:

Human readable version of the MBeanOperationInfo instance is returned