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 SummaryFieldsModifier and TypeFieldDescriptionstatic final intIndicates that the operation is write-like: it has an effect but does not return any information from the MBean.static final intIndicates that the operation is both read-like and write-like: it has an effect, and it also returns information from the MBean.static final intIndicates that the operation is read-like: it returns information but does not change any state.static final intIndicates that the impact of the operation is unknown or cannot be expressed using one of the other values.Fields declared in class javax.management.MBeanFeatureInfodescription, name
- 
Constructor SummaryConstructorsConstructorDescriptionMBeanOperationInfo(String description, Method method) Constructs anMBeanOperationInfoobject.MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact) Constructs anMBeanOperationInfoobject.MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor) Constructs anMBeanOperationInfoobject.
- 
Method SummaryModifier and TypeMethodDescriptionclone()Returns a shallow clone of this instance.booleanCompare this MBeanOperationInfo to another.intReturns 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.MBeanFeatureInfogetDescription, getDescriptor, getName
- 
Field Details- 
INFOpublic static final int INFOIndicates that the operation is read-like: it returns information but does not change any state.- See Also:
 
- 
ACTIONpublic 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_INFOpublic 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:
 
- 
UNKNOWNpublic 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- 
MBeanOperationInfoConstructs anMBeanOperationInfoobject. TheDescriptorof the constructed object will include fields contributed by any annotations on theMethodobject that contain theDescriptorKeymeta-annotation.- Parameters:
- description- A human readable description of the operation.
- method- The- java.lang.reflect.Methodobject describing the MBean operation.
 
- 
MBeanOperationInfopublic MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact) Constructs anMBeanOperationInfoobject.- Parameters:
- name- The name of the method.
- description- A human readable description of the operation.
- signature-- MBeanParameterInfoobjects 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.
 
- 
MBeanOperationInfopublic MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor) Constructs anMBeanOperationInfoobject.- Parameters:
- name- The name of the method.
- description- A human readable description of the operation.
- signature-- MBeanParameterInfoobjects 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.
- Throws:
- IllegalArgumentException- if- impactis not one of ACTION, ACTION_INFO, INFO or UNKNOWN.
- Since:
- 1.6
 
 
- 
- 
Method Details- 
cloneReturns 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. 
- 
getReturnTypeReturns the type of the method's return value.- Returns:
- the return type.
 
- 
getSignatureReturns the list of parameters for this operation. Each parameter is described by an MBeanParameterInfoobject.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 MBeanParameterInfoobjects but that each referencedMBeanParameterInfoobject is not copied.- Returns:
- An array of MBeanParameterInfoobjects.
 
- 
getImpactpublic int getImpact()Returns the impact of the method, one ofINFO, ACTION, ACTION_INFO, UNKNOWN.- Returns:
- the impact code.
 
- 
equalsCompare this MBeanOperationInfo to another.- Overrides:
- equalsin class- MBeanFeatureInfo
- Parameters:
- o- the object to compare to.
- Returns:
- true if and only if ois 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:
 
 
-