javax.management.openmbean

Interface OpenMBeanOperationInfo

All Known Implementing Classes:

OpenMBeanOperationInfoSupport

public interface OpenMBeanOperationInfo

Describes a operation for an open management bean. This interface includes those methods specified by MBeanOperationInfo, so implementations should extend this class. The getSignature() method should return an array containing instances of OpenMBeanParameterInfo.

Since:

1.5

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares this attribute with the supplied object.
String	getDescription() Returns a description of this operation.
int	getImpact() Returns the impact of performing this operation.
String	getName() Returns the name of this operation.
OpenType<?>	getReturnOpenType() Returns the open type instance which represents the type of the return value.
String	getReturnType() Returns the return type of the operation, as the class name.
MBeanParameterInfo[]	getSignature() Returns the operation's signature, in the form of information on each parameter.
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()).
String	toString() Returns a textual representation of this instance.

Method Detail

equals

boolean equals(Object obj)

Compares this attribute with the supplied object. This returns true iff the object is an instance of OpenMBeanOperationInfo with an equal name, signature, open return type and impact.

Overrides:

equals in class Object

Parameters:

obj - the object to compare.

Returns:

true if the object is a OpenMBeanParameterInfo instance, name.equals(object.getName()), signature.equals(object.getSignature()), returnOpenType.equals(object.getReturnOpenType()), and impact == object.getImpact().

See Also:

Object.hashCode()

getDescription

String getDescription()

Returns a description of this operation.

Returns:

a human-readable description.

getImpact

int getImpact()

Returns the impact of performing this operation. The value is equal to one of the following:

1. MBeanOperationInfo.INFO — the method just returns information (akin to an accessor).
2. MBeanOperationInfo.ACTION the method just alters the state of the bean, without returning a value (akin to a mutator).
3. MBeanOperationInfo.ACTION_INFO the method both makes state changes and returns a value.
4. MBeanOperationInfo.UNKNOWN the behaviour of the operation is unknown.

Returns:

the impact of performing the operation.

getName

String getName()

Returns the name of this operation.

Returns:

the name of the operation.

getReturnOpenType

OpenType<?> getReturnOpenType()

Returns the open type instance which represents the type of the return value.

Returns:

the open type of the return value.

getReturnType

String getReturnType()

Returns the return type of the operation, as the class name. This should be identical to getReturnOpenType.getClassName().

Returns:

the return type.

getSignature

MBeanParameterInfo[] getSignature()

Returns the operation's signature, in the form of information on each parameter. Each parameter is described by an instance of OpenMBeanParameterInfo.

Returns:

an array of OpenMBeanParameterInfo objects, describing the operation parameters.

hashCode

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()).

Overrides:

hashCode in class Object

Returns:

the hashcode of the operation information.

See Also:

Object.equals(Object), System.identityHashCode(Object)

toString

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.

Overrides:

toString in class Object

Returns:

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

See Also:

Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)