OpenJDK 27 · javax.management.openmbean.OpenMBeanOperationInfo

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the specified object is equal to this `OpenMBeanOperationInfo` instance. equals(Object the object to be compared for equality with this `OpenMBeanOperationInfo` instance; obj) Compares the specified `obj` parameter with this `OpenMBeanOperationInfo` instance for equality.
public String	Returns: the description. getDescription() Returns a human readable description of the operation described by this `OpenMBeanOperationInfo` instance.
public int	Returns: the impact code. getImpact() Returns an `int` constant qualifying the impact of the operation described by this `OpenMBeanOperationInfo` instance.
public String	Returns: the name. getName() Returns the name of the operation described by this `OpenMBeanOperationInfo` instance.
public OpenType<?>	Returns: the return type. getReturnOpenType() Returns the open type of the values returned by the operation described by this `OpenMBeanOperationInfo` instance.
public String	Returns: the return type. getReturnType() Returns the fully qualified Java class name of the values returned by the operation described by this `OpenMBeanOperationInfo` instance.
public MBeanParameterInfo[]	Returns: the signature. getSignature() Returns an array of `OpenMBeanParameterInfo` instances describing each parameter in the signature of the operation described by this `OpenMBeanOperationInfo` instance.
public int	Returns: the hash code value for this `OpenMBeanOperationInfo` instance hashCode() Returns the hash code value for this `OpenMBeanOperationInfo` instance.
public String	Returns: a string representation of this `OpenMBeanOperationInfo` instance toString() Returns a string representation of this `OpenMBeanOperationInfo` instance.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Compares the specified `obj` parameter with this `OpenMBeanOperationInfo` instance for equality. Returns `true` if and only if all of the following statements are true: `obj` is non null, `obj` also implements the `OpenMBeanOperationInfo` interface, their names are equal their signatures are equal their return open types are equal their impacts are equal This ensures that this `equals` method works properly for `obj` parameters which are different implementations of the `OpenMBeanOperationInfo` interface. Parameters obj:Object the object to be compared for equality with this `OpenMBeanOperationInfo` instance; Returns:boolean `true` if the specified object is equal to this `OpenMBeanOperationInfo` instance.

public boolean equals(Object obj)

Compares the specified obj parameter with this OpenMBeanOperationInfo instance for equality.

Returns true if and only if all of the following statements are true:

obj is non null,
obj also implements the OpenMBeanOperationInfo interface,
their names are equal
their signatures are equal
their return open types are equal
their impacts are equal

This ensures that this equals method works properly for obj parameters which are different implementations of the OpenMBeanOperationInfo interface.

Parameters

obj:Object: the object to be compared for equality with this OpenMBeanOperationInfo instance;

Returns:boolean

true if the specified object is equal to this OpenMBeanOperationInfo instance.

getDescription back to summary

getDescription	back to summary
public String getDescription() Returns a human readable description of the operation described by this `OpenMBeanOperationInfo` instance. Returns:String the description.

public String getDescription()

Returns a human readable description of the operation described by this OpenMBeanOperationInfo instance.

Returns:String: the description.

getImpact back to summary

getImpact	back to summary
public int getImpact() Returns an `int` constant qualifying the impact of the operation described by this `OpenMBeanOperationInfo` instance. The returned constant is one of `javax.management.MBeanOperationInfo#INFO`, `javax.management.MBeanOperationInfo#ACTION`, `javax.management.MBeanOperationInfo#ACTION_INFO`, or `javax.management.MBeanOperationInfo#UNKNOWN`. Returns:int the impact code.

public int getImpact()

Returns an int constant qualifying the impact of the operation described by this OpenMBeanOperationInfo instance. The returned constant is one of javax.management.MBeanOperationInfo#INFO, javax.management.MBeanOperationInfo#ACTION, javax.management.MBeanOperationInfo#ACTION_INFO, or javax.management.MBeanOperationInfo#UNKNOWN.

Returns:int: the impact code.

getName back to summary

getName	back to summary
public String getName() Returns the name of the operation described by this `OpenMBeanOperationInfo` instance. Returns:String the name.

public String getName()

Returns the name of the operation described by this OpenMBeanOperationInfo instance.

Returns:String: the name.

getReturnOpenType back to summary

getReturnOpenType	back to summary
public OpenType<?> getReturnOpenType() Returns the open type of the values returned by the operation described by this `OpenMBeanOperationInfo` instance. Returns:OpenType<?> the return type.

public OpenType<?> getReturnOpenType()

Returns the open type of the values returned by the operation described by this OpenMBeanOperationInfo instance.

Returns:OpenType<?>: the return type.

getReturnType back to summary

getReturnType	back to summary
public String getReturnType() Returns the fully qualified Java class name of the values returned by the operation described by this `OpenMBeanOperationInfo` instance. This method should return the same value as a call to `getReturnOpenType().getClassName()`. Returns:String the return type.

public String getReturnType()

Returns the fully qualified Java class name of the values returned by the operation described by this OpenMBeanOperationInfo instance. This method should return the same value as a call to getReturnOpenType().getClassName().

Returns:String: the return type.

getSignature back to summary

getSignature	back to summary
public MBeanParameterInfo[] getSignature() Returns an array of `OpenMBeanParameterInfo` instances describing each parameter in the signature of the operation described by this `OpenMBeanOperationInfo` instance. Each instance in the returned array should actually be a subclass of `MBeanParameterInfo` which implements the `OpenMBeanParameterInfo` interface (typically `OpenMBeanParameterInfoSupport`). Returns:MBeanParameterInfo[] the signature.

public MBeanParameterInfo[] getSignature()

Returns an array of OpenMBeanParameterInfo instances describing each parameter in the signature of the operation described by this OpenMBeanOperationInfo instance. Each instance in the returned array should actually be a subclass of MBeanParameterInfo which implements the OpenMBeanParameterInfo interface (typically OpenMBeanParameterInfoSupport).

Returns:MBeanParameterInfo[]: the signature.

hashCode back to summary

hashCode	back to summary
public int hashCode() Returns the hash code value for this `OpenMBeanOperationInfo` instance. The hash code of an `OpenMBeanOperationInfo` instance is the sum of the hash codes of all elements of information used in `equals` comparisons (ie: its name, return open type, impact and signature, where the signature hashCode is calculated by a call to `java.util.Arrays.asList(this.getSignature).hashCode()`). This ensures that `t1.equals(t2)` implies that `t1.hashCode()==t2.hashCode()` for any two `OpenMBeanOperationInfo` instances `t1` and `t2`, as required by the general contract of the method `Object.hashCode()`. Returns:int the hash code value for this `OpenMBeanOperationInfo` instance

public int hashCode()

Returns the hash code value for this OpenMBeanOperationInfo instance.

The hash code of an OpenMBeanOperationInfo instance is the sum of the hash codes of all elements of information used in equals comparisons (ie: its name, return open type, impact and signature, where the signature hashCode is calculated by a call to java.util.Arrays.asList(this.getSignature).hashCode()).

This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode() for any two OpenMBeanOperationInfo instances t1 and t2, as required by the general contract of the method Object.hashCode().

Returns:int: the hash code value for this OpenMBeanOperationInfo instance

toString back to summary

toString	back to summary
public String toString() Returns a string representation of this `OpenMBeanOperationInfo` instance. The string representation consists of the name of this class (ie `javax.management.openmbean.OpenMBeanOperationInfo`), and the name, signature, return open type and impact of the described operation. Returns:String a string representation of this `OpenMBeanOperationInfo` instance

public String toString()

Returns a string representation of this OpenMBeanOperationInfo instance.

The string representation consists of the name of this class (ie javax.management.openmbean.OpenMBeanOperationInfo), and the name, signature, return open type and impact of the described operation.

Returns:String: a string representation of this OpenMBeanOperationInfo instance

public Interface OpenMBeanOperationInfo

Method Summary

Method Detail