javax.management.openmbean
Interface OpenMBeanOperationInfo

All Known Implementing Classes:

OpenMBeanOperationInfoSupport

public interface OpenMBeanOperationInfo

Describes operation of an OpenMBean

Version:

$Revision: 1.4 $

Author:

Warren Mira, Bronwen Cassidy

Method Summary

boolean	equals(java.lang.Object obj) Test the specified object for equality.
java.lang.String	getDescription() Returs a human readable description about this operation.
int	getImpact() Returns a constant which qualifies the impact of the operation being described by the OpenMBeanOperationInfo.
java.lang.String	getName() Returns the name of the operation being described by this OpenMBeanOperationInfo
OpenType	getReturnOpenType() Return the OpenType of the values returned by this OpenMBeanOperationInfo
java.lang.String	getReturnType() Return the fully qualified class name of the values being returned by this operation.
MBeanParameterInfo[]	getSignature() Returns an array of MBeanParameterInfo for the operation
int	hashCode() Returns the hashcode of this OpenMBeanOperationInfo
java.lang.String	toString() Return a String representation

Method Detail

getDescription

public java.lang.String getDescription()

Returs a human readable description about this operation.

Returns:

String The human readable operation description

getName

public java.lang.String getName()

Returns the name of the operation being described by this OpenMBeanOperationInfo

Returns:

String the Operation name

getSignature

public MBeanParameterInfo[] getSignature()

Returns an array of MBeanParameterInfo for the operation

Parameters:

MBeanParameterInfo - An array of Parameterinfo

getImpact

public int getImpact()

Returns a constant which qualifies the impact of the operation being described by the OpenMBeanOperationInfo.

The return constant is one of the ff:

• MBeanOperationInfo.INFO
• MBeanOperationInfo.ACTION
• MBeanOperationInfo.ACTION_INFO

Returns:

int The operation impact

getReturnType

public java.lang.String getReturnType()

Return the fully qualified class name of the values being returned by this operation. Note that getReturnType and getReturnOpenType.getClassName should be equal.

Returns:

String The fully qualified classname of the return type

getReturnOpenType

public OpenType getReturnOpenType()

Return the OpenType of the values returned by this OpenMBeanOperationInfo

Returns:

OpenType The OpenType object

equals

public boolean equals(java.lang.Object obj)

Test the specified object for equality.

This method will return true if and only if the following conditions are true:

• obj is not null
• obj also implements OpenMBeanOperationInfo
• their names are equal
• their signatures are equal
• their return opentypes are equal
• their impacts are equal

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object being compared to

Returns:

boolean

hashCode

public int hashCode()

Returns the hashcode of this OpenMBeanOperationInfo

Overrides:

hashCode in class java.lang.Object

Returns:

int The hashcode

toString

public java.lang.String toString()

Return a String representation

Overrides:

toString in class java.lang.Object