OpenJDK 27 · javax.management.MBeanOperationInfo · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
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.
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.
private final transient boolean	arrayGettersSafe
private final int	impact
public static final int	INFO Indicates that the operation is read-like: it returns information but does not change any state.
pack-priv static final MBeanOperationInfo[]	NO_OPERATIONS
pack-priv static final long	serialVersionUID Hides javax.management.MBeanFeatureInfo.serialVersionUID.
private final MBeanParameterInfo[]	signature
private final String	type
public static final int	UNKNOWN Indicates that the impact of the operation is unknown or cannot be expressed using one of the other values.

Inherited from javax.management.MBeanFeatureInfo:: description name

Constructor Summary

Access	Constructor and Description
public	MBeanOperationInfo(String A human readable description of the operation. description, Method The `java.lang.reflect.Method` object describing the MBean operation. method) Constructs an `MBeanOperationInfo` object.
public	MBeanOperationInfo(String The name of the method. name, String A human readable description of the operation. description, MBeanParameterInfo[] `MBeanParameterInfo` objects describing the parameters(arguments) of the method. This may be null with the same effect as a zero-length array. signature, String The type of the method's return value. type, int The impact of the method, one of `INFO`, `ACTION`, `ACTION_INFO`, `UNKNOWN`. impact) Constructs an `MBeanOperationInfo` object.
public	MBeanOperationInfo(String The name of the method. name, String A human readable description of the operation. description, MBeanParameterInfo[] `MBeanParameterInfo` objects describing the parameters(arguments) of the method. This may be null with the same effect as a zero-length array. signature, String The type of the method's return value. type, int The impact of the method, one of `INFO`, `ACTION`, `ACTION_INFO`, `UNKNOWN`. impact, Descriptor The descriptor for the operation. This may be null which is equivalent to an empty descriptor. descriptor) Constructs an `MBeanOperationInfo` object.

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides java.lang.Object.clone. Returns a shallow clone of this instance.
public boolean	Returns: true if and only if `o` is an MBeanOperationInfo such that its `getName()`, `getReturnType()`, `getDescription()`, `getImpact()`, `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. equals(Object the object to compare to. o) Overrides javax.management.MBeanFeatureInfo.equals. Compare this MBeanOperationInfo to another.
private MBeanParameterInfo[]	fastGetSignature()
public int	Returns: the impact code. getImpact() Returns the impact of the method, one of `INFO, ACTION, ACTION_INFO, UNKNOWN`.
public String	Returns: the return type. getReturnType() Returns the type of the method's return value.
public MBeanParameterInfo[]	Returns: An array of `MBeanParameterInfo` objects. getSignature() Returns the list of parameters for this operation.
public int	hashCode() Overrides javax.management.MBeanFeatureInfo.hashCode. Returns a hash code value for this object.
private static MBeanParameterInfo[]	methodSignature(Method method)
pack-priv static MBeanParameterInfo[]	parameters(Class<?>[] classes, Annotation[][] annots)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from javax.management.MBeanFeatureInfo:: getDescription getDescriptor getName

Field Detail

ACTION	back to summary
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.

ACTION_INFO	back to summary
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.

arrayGettersSafe	back to summary
private final transient boolean arrayGettersSafe See Also `MBeanInfo#arrayGettersSafe`

impact	back to summary
private final int impact

INFO	back to summary
public static final int INFO Indicates that the operation is read-like: it returns information but does not change any state.

NO_OPERATIONS	back to summary
pack-priv static final MBeanOperationInfo[] NO_OPERATIONS

serialVersionUID	back to summary
pack-priv static final long serialVersionUID Hides javax.management.MBeanFeatureInfo.serialVersionUID.

signature	back to summary
private final MBeanParameterInfo[] signature

type	back to summary
private final String type

UNKNOWN	back to summary
public static final int UNKNOWN Indicates that the impact of the operation is unknown or cannot be expressed using one of the other values.

Constructor Detail

MBeanOperationInfo back to summary

MBeanOperationInfo	back to summary
public MBeanOperationInfo(String description, Method method) Constructs an `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. Parameters description:String A human readable description of the operation. method:Method The `java.lang.reflect.Method` object describing the MBean operation.

public MBeanOperationInfo(String description, Method method)

Constructs an 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.

Parameters

description:String: A human readable description of the operation.
method:Method: The java.lang.reflect.Method object describing the MBean operation.

MBeanOperationInfo back to summary

MBeanOperationInfo	back to summary
public MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact) Constructs an `MBeanOperationInfo` object. Parameters name:String The name of the method. description:String A human readable description of the operation. signature:MBeanParameterInfo[] `MBeanParameterInfo` objects describing the parameters(arguments) of the method. This may be null with the same effect as a zero-length array. type:String The type of the method's return value. impact:int The impact of the method, one of `INFO`, `ACTION`, `ACTION_INFO`, `UNKNOWN`.

public MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact)

Constructs an MBeanOperationInfo object.

Parameters

name:String: The name of the method.
description:String: A human readable description of the operation.
signature:MBeanParameterInfo[]: MBeanParameterInfo objects describing the parameters(arguments) of the method. This may be null with the same effect as a zero-length array.
type:String: The type of the method's return value.
impact:int: The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.

MBeanOperationInfo back to summary

MBeanOperationInfo	back to summary
public MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor) Constructs an `MBeanOperationInfo` object. Parameters name:String The name of the method. description:String A human readable description of the operation. signature:MBeanParameterInfo[] `MBeanParameterInfo` objects describing the parameters(arguments) of the method. This may be null with the same effect as a zero-length array. type:String The type of the method's return value. impact:int The impact of the method, one of `INFO`, `ACTION`, `ACTION_INFO`, `UNKNOWN`. descriptor:Descriptor The descriptor for the operation. This may be null which is equivalent to an empty descriptor. Exceptions IllegalArgumentException: if `impact` is not one of ACTION, ACTION_INFO, INFO or UNKNOWN. Since 1.6

public MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor)

Constructs an MBeanOperationInfo object.

Parameters

name:String: The name of the method.
description:String: A human readable description of the operation.
signature:MBeanParameterInfo[]: MBeanParameterInfo objects describing the parameters(arguments) of the method. This may be null with the same effect as a zero-length array.
type:String: The type of the method's return value.
impact:int: The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
descriptor:Descriptor: The descriptor for the operation. This may be null which is equivalent to an empty descriptor.

Exceptions

IllegalArgumentException:: if impact is not one of ACTION, ACTION_INFO, INFO or UNKNOWN.

Since

1.6

Method Detail

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.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. Annotations @Override

public Object clone()

Overrides java.lang.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.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides javax.management.MBeanFeatureInfo.equals. Compare this MBeanOperationInfo to another. Parameters o:Object the object to compare to. Returns:boolean true if and only if `o` is an MBeanOperationInfo such that its `getName()`, `getReturnType()`, `getDescription()`, `getImpact()`, `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. Annotations @Override

public boolean equals(Object o)

Overrides javax.management.MBeanFeatureInfo.equals.

Compare this MBeanOperationInfo to another.

Parameters

o:Object: the object to compare to.

Returns:boolean

true if and only if o is an MBeanOperationInfo such that its getName(), getReturnType(), getDescription(), getImpact(), 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.

Annotations

@Override

fastGetSignature	back to summary
private MBeanParameterInfo[] fastGetSignature()

getImpact back to summary

getImpact	back to summary
public int getImpact() Returns the impact of the method, one of `INFO, ACTION, ACTION_INFO, UNKNOWN`. Returns:int the impact code.

public int getImpact()

Returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.

Returns:int: the impact code.

getReturnType	back to summary
public String getReturnType() Returns the type of the method's return value. Returns:String the return type.

getReturnType

back to summary

public String getReturnType()

Returns the type of the method's return value.

Returns:String: the return type.

getSignature back to summary

getSignature	back to summary
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. Returns:MBeanParameterInfo[] An array of `MBeanParameterInfo` objects.

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.

Returns:MBeanParameterInfo[]: An array of MBeanParameterInfo objects.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides javax.management.MBeanFeatureInfo.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons 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` method, then calling the `hashCode` method 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 `equals` method, then calling the `hashCode` method 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. Annotations @Override

public int hashCode()

Overrides javax.management.MBeanFeatureInfo.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons 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 method, then calling the hashCode method 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 equals method, then calling the hashCode method 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.

Annotations

@Override

methodSignature	back to summary
private static MBeanParameterInfo[] methodSignature(Method method)

parameters	back to summary
pack-priv static MBeanParameterInfo[] parameters(Class<?>[] classes, Annotation[][] annots)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class MBeanOperationInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail