- java.lang.Object
-
- javax.management.MBeanFeatureInfo
-
- javax.management.MBeanOperationInfo
-
- All Implemented Interfaces:
Serializable,Cloneable,DescriptorRead
- Direct Known Subclasses:
ModelMBeanOperationInfo,OpenMBeanOperationInfoSupport
public class MBeanOperationInfo extends MBeanFeatureInfo implements Cloneable
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:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static intACTIONIndicates that the operation is write-like: it has an effect but does not return any information from the MBean.static intACTION_INFOIndicates that the operation is both read-like and write-like: it has an effect, and it also returns information from the MBean.static intINFOIndicates that the operation is read-like: it returns information but does not change any state.static intUNKNOWNIndicates that the impact of the operation is unknown or cannot be expressed using one of the other values.-
Fields inherited from class javax.management.MBeanFeatureInfo
description, name
-
-
Constructor Summary
Constructors Constructor Description MBeanOperationInfo(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 Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectclone()Returns a shallow clone of this instance.booleanequals(Object o)Compare this MBeanOperationInfo to another.intgetImpact()Returns the impact of the method, one ofINFO, ACTION, ACTION_INFO, UNKNOWN.StringgetReturnType()Returns the type of the method's return value.MBeanParameterInfo[]getSignature()Returns the list of parameters for this operation.inthashCode()Returns a hash code value for the object.StringtoString()Returns a string representation of the object.-
Methods inherited from class javax.management.MBeanFeatureInfo
getDescription, getDescriptor, getName
-
-
-
-
Field Detail
-
INFO
public static final int INFO
Indicates that the operation is read-like: it returns information but does not change any state.- See Also:
- Constant Field Values
-
ACTION
public static final int ACTION
Indicates that the operation is write-like: it has an effect but does not return any information from the MBean.- See Also:
- Constant Field Values
-
ACTION_INFO
public static final int ACTION_INFO
Indicates that the operation is both read-like and write-like: it has an effect, and it also returns information from the MBean.- See Also:
- Constant Field Values
-
UNKNOWN
public static final int UNKNOWN
Indicates that the impact of the operation is unknown or cannot be expressed using one of the other values.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MBeanOperationInfo
public MBeanOperationInfo(String description, Method method)
Constructs anMBeanOperationInfoobject. TheDescriptorof the constructed object will include fields contributed by any annotations on theMethodobject that contain theDescriptorKeymeta-annotation.- Parameters:
method- Thejava.lang.reflect.Methodobject describing the MBean operation.description- A human readable description of the operation.
-
MBeanOperationInfo
public 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 ofINFO,ACTION,ACTION_INFO,UNKNOWN.
-
MBeanOperationInfo
public 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 ofINFO,ACTION,ACTION_INFO,UNKNOWN.descriptor- The descriptor for the operation. This may be null which is equivalent to an empty descriptor.- Since:
- 1.6
-
-
Method Detail
-
clone
public Object 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
public String getReturnType()
Returns the type of the method's return value.- Returns:
- the return type.
-
getSignature
public MBeanParameterInfo[] getSignature()
Returns 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.
-
getImpact
public int getImpact()
Returns the impact of the method, one ofINFO, ACTION, ACTION_INFO, UNKNOWN.- Returns:
- the impact code.
-
toString
public String toString()
Description copied from class:ObjectReturns a string representation of the object. In general, thetoStringmethod returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.The
toStringmethod for classObjectreturns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:getClass().getName() + '@' + Integer.toHexString(hashCode())
-
equals
public boolean equals(Object o)
Compare this MBeanOperationInfo to another.- Overrides:
equalsin classMBeanFeatureInfo- 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:
Object.hashCode(),HashMap
-
hashCode
public int hashCode()
Description copied from class:ObjectReturns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided byHashMap.The general contract of
hashCodeis:- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals(Object)method, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
Object.equals(java.lang.Object)method, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by class
Objectdoes return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)- Overrides:
hashCodein classMBeanFeatureInfo- Returns:
- a hash code value for this object.
- See Also:
Object.equals(java.lang.Object),System.identityHashCode(java.lang.Object)
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
-
-