Serializable
, Cloneable
, DescriptorRead
ModelMBeanOperationInfo
, OpenMBeanOperationInfoSupport
public class MBeanOperationInfo extends MBeanFeatureInfo implements Cloneable
Modifier and Type | Field | Description |
---|---|---|
static final int |
ACTION |
Indicates that the operation is write-like: it has an effect but does not return any information from the MBean. |
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. |
static final int |
INFO |
Indicates that the operation is read-like: it returns information but does not change any state. |
static final int |
UNKNOWN |
Indicates that the impact of the operation is unknown or cannot be expressed using one of the other values. |
description, name
Constructor | Description |
---|---|
MBeanOperationInfo |
Constructs an MBeanOperationInfo object. |
MBeanOperationInfo |
Constructs an MBeanOperationInfo object. |
MBeanOperationInfo |
Constructs an MBeanOperationInfo object. |
Modifier and Type | Method | Description |
---|---|---|
Object |
clone() |
Returns a shallow clone of this instance. |
boolean |
equals |
Compare this MBeanOperationInfo to another. |
int |
getImpact() |
Returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN . |
String |
getReturnType() |
Returns the type of the method's return value. |
MBeanParameterInfo[] |
getSignature() |
Returns the list of parameters for this operation. |
getDescription, getDescriptor, 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 description, Method method)
MBeanOperationInfo
object. The Descriptor
of the constructed object will include fields contributed by any annotations on the Method
object that contain the DescriptorKey
meta-annotation.description
- A human readable description of the operation.method
- The java.lang.reflect.Method
object describing the MBean operation.public MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact)
MBeanOperationInfo
object.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
.public MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor)
MBeanOperationInfo
object.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
.descriptor
- The descriptor for the operation. This may be null which is equivalent to an empty descriptor.IllegalArgumentException
- if impact
is not one of ACTION, ACTION_INFO, INFO or UNKNOWN.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 by Object.clone()
. No deeper cloning of any internal field is made.
Since this class is immutable, cloning is chiefly of interest to subclasses.
public String getReturnType()
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.
MBeanParameterInfo
objects.public int getImpact()
INFO, ACTION, ACTION_INFO, UNKNOWN
.public boolean equals(Object o)
equals
in class MBeanFeatureInfo
o
- the object to compare to.o
is an MBeanOperationInfo such that its MBeanFeatureInfo.getName()
, getReturnType()
, MBeanFeatureInfo.getDescription()
, getImpact()
, MBeanFeatureInfo.getDescriptor()
and getSignature()
values are equal (not necessarily identical) to those of this MBeanConstructorInfo. Two signature arrays are equal if their elements are pairwise equal.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.management/javax/management/MBeanOperationInfo.html