javax.management.openmbean
Interface OpenMBeanOperationInfo

All Known Implementing Classes:

OpenMBeanOperationInfoSupport

public interface OpenMBeanOperationInfo

An open MBean operation info implements this interface as well as extending MBeanOperationInfo.

OpenMBeanOperationInfoSupport is an example of such a class.

Version:

$Revision: 1.3.6.1 $

Author:

Adrian Brock.

Method Summary

boolean	equals(Object obj) Compares an object for equality with the implementing class.
String	getDescription() Retrieve a human readable description of the open MBean operation the implementation of this interface describes.
int	getImpact() Retrieves the impact of the operation. One of MBeanOperationInfo.INFO MBeanOperationInfo.ACTION MBeanOperationInfo.ACTION_INFO
String	getName() Retrieve the name of the operation described.
OpenType	getReturnOpenType() Retrieves the open type return type of operation.
String	getReturnType() Retrieves the return type of operation. This must be same as getReturnOpenType().getClassName()
MBeanParameterInfo[]	getSignature() Returns an array of the parameters passed to the operation
int	hashCode() Generates a hashcode for the implementation.
String	toString() A string representation of the open mbean operation info.

Method Detail

getDescription

String getDescription()

Retrieve a human readable description of the open MBean operation the implementation of this interface describes.

Returns:

the description.

getName

String getName()

Retrieve the name of the operation described.

Returns:

the name.

getSignature

MBeanParameterInfo[] getSignature()

Returns an array of the parameters passed to the operation

The parameters must be OpenMBeanParameterInfos.

Returns:

the operation's parameters.

getImpact

int getImpact()

Retrieves the impact of the operation. One of
MBeanOperationInfo.INFO
MBeanOperationInfo.ACTION
MBeanOperationInfo.ACTION_INFO

Returns:

the impact.

getReturnType

String getReturnType()

Retrieves the return type of operation. This must be same as getReturnOpenType().getClassName()

Returns:

the return type.

getReturnOpenType

OpenType getReturnOpenType()

Retrieves the open type return type of operation.

Returns:

the open type of the return type.

equals

boolean equals(Object obj)

Compares an object for equality with the implementing class.

The object is not null
The object implements the open mbean operation info interface
The operation names are equal
The signatures are equal
The return types are equal
The impacts are equal

Overrides:

equals in class Object

Parameters:

obj - the object to test

Returns:

true when above is true, false otherwise

hashCode

int hashCode()

Generates a hashcode for the implementation.

The sum of the hashCodes for the elements mentioned in the equals method

Overrides:

hashCode in class Object

Returns:

the calculated hashcode

toString

String toString()

A string representation of the open mbean operation info.

It is made up of implementation class and the values mentioned in the equals method

Overrides:

toString in class Object

Returns:

the string