javax.management.openmbean
Interface OpenMBeanOperationInfo

All Known Implementing Classes:
OpenMBeanOperationInfoSupport sample code for javax.management.openmbean.OpenMBeanOperationInfoSupport definition code for javax.management.openmbean.OpenMBeanOperationInfoSupport

public interface OpenMBeanOperationInfo

Describes an operation of an Open MBean.

This interface declares the same methods as the class MBeanOperationInfo sample code for javax.management.MBeanOperationInfo definition code for javax.management.MBeanOperationInfo . A class implementing this interface (typically OpenMBeanOperationInfoSupport sample code for javax.management.openmbean.OpenMBeanOperationInfoSupport definition code for javax.management.openmbean.OpenMBeanOperationInfoSupport ) should extend MBeanOperationInfo sample code for javax.management.MBeanOperationInfo definition code for javax.management.MBeanOperationInfo .

The getSignature() sample code for javax.management.openmbean.OpenMBeanOperationInfo.getSignature() definition code for javax.management.openmbean.OpenMBeanOperationInfo.getSignature() method should return at runtime an array of instances of a subclass of MBeanParameterInfo sample code for javax.management.MBeanParameterInfo definition code for javax.management.MBeanParameterInfo which implements the OpenMBeanParameterInfo sample code for javax.management.openmbean.OpenMBeanParameterInfo definition code for javax.management.openmbean.OpenMBeanParameterInfo interface (typically OpenMBeanParameterInfoSupport sample code for javax.management.openmbean.OpenMBeanParameterInfoSupport definition code for javax.management.openmbean.OpenMBeanParameterInfoSupport ).

Since:
1.5

Method Summary
 boolean equals sample code for javax.management.openmbean.OpenMBeanOperationInfo.equals(java.lang.Object) definition code for javax.management.openmbean.OpenMBeanOperationInfo.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Compares the specified obj parameter with this OpenMBeanOperationInfo instance for equality.
 String sample code for java.lang.String definition code for java.lang.String getDescription sample code for javax.management.openmbean.OpenMBeanOperationInfo.getDescription() definition code for javax.management.openmbean.OpenMBeanOperationInfo.getDescription() ()
          Returns a human readable description of the operation described by this OpenMBeanOperationInfo instance.
 int getImpact sample code for javax.management.openmbean.OpenMBeanOperationInfo.getImpact() definition code for javax.management.openmbean.OpenMBeanOperationInfo.getImpact() ()
          Returns an int constant qualifying the impact of the operation described by this OpenMBeanOperationInfo instance.
 String sample code for java.lang.String definition code for java.lang.String getName sample code for javax.management.openmbean.OpenMBeanOperationInfo.getName() definition code for javax.management.openmbean.OpenMBeanOperationInfo.getName() ()
          Returns the name of the operation described by this OpenMBeanOperationInfo instance.
 OpenType sample code for javax.management.openmbean.OpenType definition code for javax.management.openmbean.OpenType getReturnOpenType sample code for javax.management.openmbean.OpenMBeanOperationInfo.getReturnOpenType() definition code for javax.management.openmbean.OpenMBeanOperationInfo.getReturnOpenType() ()
          Returns the open type of the values returned by the operation described by this OpenMBeanOperationInfo instance.
 String sample code for java.lang.String definition code for java.lang.String getReturnType sample code for javax.management.openmbean.OpenMBeanOperationInfo.getReturnType() definition code for javax.management.openmbean.OpenMBeanOperationInfo.getReturnType() ()
          Returns the fully qualified Java class name of the values returned by the operation described by this OpenMBeanOperationInfo instance.
 MBeanParameterInfo sample code for javax.management.MBeanParameterInfo definition code for javax.management.MBeanParameterInfo [] getSignature sample code for javax.management.openmbean.OpenMBeanOperationInfo.getSignature() definition code for javax.management.openmbean.OpenMBeanOperationInfo.getSignature() ()
          Returns an array of OpenMBeanParameterInfo instances describing each parameter in the signature of the operation described by this OpenMBeanOperationInfo instance.
 int hashCode sample code for javax.management.openmbean.OpenMBeanOperationInfo.hashCode() definition code for javax.management.openmbean.OpenMBeanOperationInfo.hashCode() ()
          Returns the hash code value for this OpenMBeanOperationInfo instance.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for javax.management.openmbean.OpenMBeanOperationInfo.toString() definition code for javax.management.openmbean.OpenMBeanOperationInfo.toString() ()
          Returns a string representation of this OpenMBeanOperationInfo instance.
 

Method Detail

getDescription sample code for javax.management.openmbean.OpenMBeanOperationInfo.getDescription() definition code for javax.management.openmbean.OpenMBeanOperationInfo.getDescription()

String sample code for java.lang.String definition code for java.lang.String  getDescription()
Returns a human readable description of the operation described by this OpenMBeanOperationInfo instance.

Returns:
the description.

getName sample code for javax.management.openmbean.OpenMBeanOperationInfo.getName() definition code for javax.management.openmbean.OpenMBeanOperationInfo.getName()

String sample code for java.lang.String definition code for java.lang.String  getName()
Returns the name of the operation described by this OpenMBeanOperationInfo instance.

Returns:
the name.

getSignature sample code for javax.management.openmbean.OpenMBeanOperationInfo.getSignature() definition code for javax.management.openmbean.OpenMBeanOperationInfo.getSignature()

MBeanParameterInfo sample code for javax.management.MBeanParameterInfo definition code for 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 OpenMBeanParameterInfoSupport sample code for javax.management.openmbean.OpenMBeanParameterInfoSupport definition code for javax.management.openmbean.OpenMBeanParameterInfoSupport ).

Returns:
the signature.

getImpact sample code for javax.management.openmbean.OpenMBeanOperationInfo.getImpact() definition code for javax.management.openmbean.OpenMBeanOperationInfo.getImpact()

int getImpact()
Returns an int constant qualifying the impact of the operation described by this OpenMBeanOperationInfo instance. The returned constant is one of MBeanOperationInfo.INFO sample code for javax.management.MBeanOperationInfo.INFO definition code for javax.management.MBeanOperationInfo.INFO , MBeanOperationInfo.ACTION sample code for javax.management.MBeanOperationInfo.ACTION definition code for javax.management.MBeanOperationInfo.ACTION or MBeanOperationInfo.ACTION_INFO sample code for javax.management.MBeanOperationInfo.ACTION_INFO definition code for javax.management.MBeanOperationInfo.ACTION_INFO .

Returns:
the impact code.

getReturnType sample code for javax.management.openmbean.OpenMBeanOperationInfo.getReturnType() definition code for javax.management.openmbean.OpenMBeanOperationInfo.getReturnType()

String sample code for java.lang.String definition code for java.lang.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:
the return type.

getReturnOpenType sample code for javax.management.openmbean.OpenMBeanOperationInfo.getReturnOpenType() definition code for javax.management.openmbean.OpenMBeanOperationInfo.getReturnOpenType()

OpenType sample code for javax.management.openmbean.OpenType definition code for javax.management.openmbean.OpenType  getReturnOpenType()
Returns the open type of the values returned by the operation described by this OpenMBeanOperationInfo instance.

Returns:
the return type.

equals sample code for javax.management.openmbean.OpenMBeanOperationInfo.equals(java.lang.Object) definition code for javax.management.openmbean.OpenMBeanOperationInfo.equals(java.lang.Object)

boolean equals(Object sample code for java.lang.Object definition code for 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:

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

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
Parameters:
obj - the object to be compared for equality with this OpenMBeanOperationInfo instance;
Returns:
true if the specified object is equal to this OpenMBeanOperationInfo instance.
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

hashCode sample code for javax.management.openmbean.OpenMBeanOperationInfo.hashCode() definition code for javax.management.openmbean.OpenMBeanOperationInfo.hashCode()

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() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() .

Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
the hash code value for this OpenMBeanOperationInfo instance
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

toString sample code for javax.management.openmbean.OpenMBeanOperationInfo.toString() definition code for javax.management.openmbean.OpenMBeanOperationInfo.toString()

String sample code for java.lang.String definition code for java.lang.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.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a string representation of this OpenMBeanOperationInfo instance