java.lang.Object
javax.management.MBeanFeatureInfo
javax.management.MBeanOperationInfo
- All Implemented Interfaces:
Serializable
,Cloneable
,DescriptorRead
- 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.
- Since:
- 1.5
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Indicates that the operation is write-like: it has an effect but does not return any information from the MBean.static final int
Indicates that the operation is both read-like and write-like: it has an effect, and it also returns information from the MBean.static final int
Indicates that the operation is read-like: it returns information but does not change any state.static final int
Indicates that the impact of the operation is unknown or cannot be expressed using one of the other values.Fields declared in class javax.management.MBeanFeatureInfo
description, name
-
Constructor Summary
ConstructorDescriptionMBeanOperationInfo
(String description, Method method) Constructs anMBeanOperationInfo
object.MBeanOperationInfo
(String name, String description, MBeanParameterInfo[] signature, String type, int impact) Constructs anMBeanOperationInfo
object.MBeanOperationInfo
(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor) Constructs anMBeanOperationInfo
object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Returns a shallow clone of this instance.boolean
Compare this MBeanOperationInfo to another.int
Returns the impact of the method, one ofINFO, ACTION, ACTION_INFO, UNKNOWN
.Returns the type of the method's return value.Returns the list of parameters for this operation.Methods declared in class javax.management.MBeanFeatureInfo
getDescription, getDescriptor, getName
-
Field Details
-
INFO
public static final int INFOIndicates that the operation is read-like: it returns information but does not change any state.- See Also:
-
ACTION
public static final int ACTIONIndicates that the operation is write-like: it has an effect but does not return any information from the MBean.- See Also:
-
ACTION_INFO
public static final int ACTION_INFOIndicates that the operation is both read-like and write-like: it has an effect, and it also returns information from the MBean.- See Also:
-
UNKNOWN
public static final int UNKNOWNIndicates that the impact of the operation is unknown or cannot be expressed using one of the other values.- See Also:
-
-
Constructor Details
-
MBeanOperationInfo
Constructs anMBeanOperationInfo
object. TheDescriptor
of the constructed object will include fields contributed by any annotations on theMethod
object that contain theDescriptorKey
meta-annotation.- Parameters:
description
- A human readable description of the operation.method
- Thejava.lang.reflect.Method
object describing the MBean operation.
-
MBeanOperationInfo
public MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact) Constructs anMBeanOperationInfo
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 ofINFO
,ACTION
,ACTION_INFO
,UNKNOWN
.
-
MBeanOperationInfo
public MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor) Constructs anMBeanOperationInfo
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 ofINFO
,ACTION
,ACTION_INFO
,UNKNOWN
.descriptor
- The descriptor for the operation. This may be null which is equivalent to an empty descriptor.- Throws:
IllegalArgumentException
- ifimpact
is not one of ACTION, ACTION_INFO, INFO or UNKNOWN.- Since:
- 1.6
-
-
Method Details
-
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 byObject.clone()
. No deeper cloning of any internal field is made.Since this class is immutable, cloning is chiefly of interest to subclasses.
-
getReturnType
Returns the type of the method's return value.- Returns:
- the return type.
-
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 referencedMBeanParameterInfo
object is not copied.- Returns:
- An array of
MBeanParameterInfo
objects.
-
getImpact
public int getImpact()Returns the impact of the method, one ofINFO, ACTION, ACTION_INFO, UNKNOWN
.- Returns:
- the impact code.
-
equals
Compare this MBeanOperationInfo to another.- Overrides:
equals
in classMBeanFeatureInfo
- Parameters:
o
- the object to compare to.- Returns:
- true if and only if
o
is an MBeanOperationInfo such that itsMBeanFeatureInfo.getName()
,getReturnType()
,MBeanFeatureInfo.getDescription()
,getImpact()
,MBeanFeatureInfo.getDescriptor()
andgetSignature()
values are equal (not necessarily identical) to those of this MBeanConstructorInfo. Two signature arrays are equal if their elements are pairwise equal. - See Also:
-