public class MBeanOperationInfo extends MBeanFeatureInfo implements Cloneable
Modifier and Type | Field and Description |
---|---|
static int |
ACTION
Used to signify that the operation makes some change to the
state of the bean (akin to a mutator).
|
static int |
ACTION_INFO
Used to signify that the operation makes some state change
to the bean and also returns information.
|
static int |
INFO
Used to signify that the operation merely provides information
(akin to an accessor).
|
static int |
UNKNOWN
Used to signify that the behaviour of the operation is
unknown.
|
description, name
Constructor and Description |
---|
MBeanOperationInfo(String desc,
Method method)
Constructs a @link{MBeanOperationInfo} with the specified
description using the given method.
|
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.
|
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Returns a clone of this instance.
|
boolean |
equals(Object obj)
Compares this feature with the supplied object.
|
int |
getImpact()
Returns the impact of performing this operation.
|
String |
getReturnType()
Returns the return type of the operation, as the class
name.
|
MBeanParameterInfo[] |
getSignature()
Returns the operation's signature, in the form of
information on each parameter.
|
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.
|
String |
toString()
Returns a textual representation of this instance.
|
getDescription, getName
public static final int INFO
public static final int ACTION
public static final int ACTION_INFO
public static final int UNKNOWN
public MBeanOperationInfo(String desc, Method method)
null
. The return type and impact of the
method are determined from the Method
instance.desc
- a description of the attribute.method
- the method.public MBeanOperationInfo(String name, String desc, MBeanParameterInfo[] sig, String type, int impact)
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.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 Object clone()
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.public boolean equals(Object obj)
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).equals
in class MBeanFeatureInfo
obj
- the object to compare.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.Object.hashCode()
public int getImpact()
Returns the impact of performing this operation. The value is equal to one of the following:
INFO
— the method just returns
information (akin to an accessor).ACTION
— the method just alters
the state of the bean, without returning a value
(akin to a mutator).ACTION_INFO
— the method both makes
state changes and returns a value.UNKNOWN
— the behaviour of the operation
is unknown.public String getReturnType()
public MBeanParameterInfo[] getSignature()
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.MBeanParameterInfo
objects,
describing the operation parameters.public int hashCode()
hashCode
in class MBeanFeatureInfo
Object.equals(Object)
,
System.identityHashCode(Object)
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.
toString
in class MBeanFeatureInfo
Object.getClass()
,
Object.hashCode()
,
Class.getName()
,
Integer.toHexString(int)