javax.management.openmbean

Class OpenMBeanOperationInfoSupport

public class OpenMBeanOperationInfoSupport extends MBeanOperationInfo implements OpenMBeanOperationInfo

Describes a operation for an open management bean.

Since: 1.5

Constructor Summary
OpenMBeanOperationInfoSupport(String name, String desc, OpenMBeanParameterInfo[] sig, OpenType<?> type, int impact)
Constructs a @link{OpenMBeanOperationInfo} with the specified name, description, parameter information, open return type and impact.
Method Summary
booleanequals(Object obj)
Compares this attribute with the supplied object.
OpenType<?>getReturnOpenType()
Returns the open type instance which represents the type of the return value.
inthashCode()

Returns the hashcode of the operation information as the sum of the hashcodes of the name, open return type, impact and signature (calculated by java.util.Arrays.asList(signature).hashCode()).

StringtoString()

Returns a textual representation of this instance.

Constructor Detail

OpenMBeanOperationInfoSupport

public OpenMBeanOperationInfoSupport(String name, String desc, OpenMBeanParameterInfo[] sig, OpenType<?> type, int impact)
Constructs a @link{OpenMBeanOperationInfo} with the specified name, description, parameter information, open return type and impact. A null value for the parameter information is the same as passing in an empty array. A copy of the parameter array is taken, so later changes have no effect. The name and the description may not be equal to the empty string, and neither the name, description nor the open return type may be null. The value of impact must be one of the four valid values ({@link javax.management.MBeanOperationInfo#INFO}, {@link javax.management.MBeanOperationInfo#ACTION}, {@link javax.management.MBeanOperationInfo#ACTION_INFO} and {@link javax.management.MBeanOperationInfo#UNKNOWN}).

Parameters: name the name of the constructor. desc a description of the attribute. sig the signature of the method, as a series of {@link MBeanParameterInfo} objects, one for each parameter. type the open return type of the method. impact the impact of performing the operation.

Throws: IllegalArgumentException if the name, description or open return type is null, the name or description are equal to the empty string, or the impact factor is not one of the values enumerated above. ArrayStoreException if the members of the signature array are not assignable to {@link javax.management.MBeanParameterInfo}

Method Detail

equals

public boolean equals(Object obj)
Compares this attribute with the supplied object. This returns true iff the object is an instance of {@link OpenMBeanOperationInfo} with an equal name, signature, open return type and impact.

Parameters: obj the object to compare.

Returns: true if the object is a {@link OpenMBeanParameterInfo} instance, name.equals(object.getName()), signature.equals(object.getSignature()), returnOpenType.equals(object.getReturnOpenType()), and impact == object.getImpact().

getReturnOpenType

public OpenType<?> getReturnOpenType()
Returns the open type instance which represents the type of the return value.

Returns: the open type of the return value.

hashCode

public int hashCode()

Returns the hashcode of the operation information as the sum of the hashcodes of the name, open return type, impact and signature (calculated by java.util.Arrays.asList(signature).hashCode()).

As instances of this class are immutable, the return value is computed just once for each instance and reused throughout its life.

Returns: the hashcode of the operation information.

toString

public String toString()

Returns a textual representation of this instance. This is constructed using the class name (javax.management.openmbean.OpenMBeanOperationInfo) along with the name, signature, open return type and impact.

As instances of this class are immutable, the return value is computed just once for each instance and reused throughout its life.

Returns: a @link{java.lang.String} instance representing the instance in textual form.