FileDocCategorySizeDatePackage
OpenMBeanOperationInfo.javaAPI DocJava SE 6 API6058Tue Jun 10 00:26:16 BST 2008javax.management.openmbean

OpenMBeanOperationInfo

public interface OpenMBeanOperationInfo

Describes an operation of an Open MBean.

This interface declares the same methods as the class {@link javax.management.MBeanOperationInfo}. A class implementing this interface (typically {@link OpenMBeanOperationInfoSupport}) should extend {@link javax.management.MBeanOperationInfo}.

The {@link #getSignature()} method should return at runtime an array of instances of a subclass of {@link MBeanParameterInfo} which implements the {@link OpenMBeanParameterInfo} interface (typically {@link OpenMBeanParameterInfoSupport}).

version
3.23 05/12/01
author
Sun Microsystems, Inc.
since
1.5
since.unbundled
JMX 1.1

Fields Summary
Constructors Summary
Methods Summary
public booleanequals(java.lang.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.
 

param
obj the object to be compared for equality with this OpenMBeanOperationInfo instance;
return
true if the specified object is equal to this OpenMBeanOperationInfo instance.

public java.lang.StringgetDescription()
Returns a human readable description of the operation described by this OpenMBeanOperationInfo instance.

return
the description.

public intgetImpact()
Returns an int constant qualifying the impact of the operation described by this OpenMBeanOperationInfo instance. The returned constant is one of {@link javax.management.MBeanOperationInfo#INFO}, {@link javax.management.MBeanOperationInfo#ACTION}, {@link javax.management.MBeanOperationInfo#ACTION_INFO}, or {@link javax.management.MBeanOperationInfo#UNKNOWN}.

return
the impact code.

public java.lang.StringgetName()
Returns the name of the operation described by this OpenMBeanOperationInfo instance.

return
the name.

public javax.management.openmbean.OpenTypegetReturnOpenType()
Returns the open type of the values returned by the operation described by this OpenMBeanOperationInfo instance.

return
the return type.

public java.lang.StringgetReturnType()
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().

return
the return type.

public javax.management.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 {@link OpenMBeanParameterInfoSupport}).

return
the signature.

public inthashCode()
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 {@link Object#hashCode() Object.hashCode()}.

return
the hash code value for this OpenMBeanOperationInfo instance

public java.lang.StringtoString()
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.

return
a string representation of this OpenMBeanOperationInfo instance