-
- All Known Implementing Classes:
OpenMBeanOperationInfoSupport
public interface OpenMBeanOperationInfoDescribes an operation of an Open MBean.
This interface declares the same methods as the class
MBeanOperationInfo. A class implementing this interface (typicallyOpenMBeanOperationInfoSupport) should extendMBeanOperationInfo.The
getSignature()method should return at runtime an array of instances of a subclass ofMBeanParameterInfowhich implements theOpenMBeanParameterInfointerface (typicallyOpenMBeanParameterInfoSupport).- Since:
- 1.5
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanequals(Object obj)Compares the specified obj parameter with thisOpenMBeanOperationInfoinstance for equality.StringgetDescription()Returns a human readable description of the operation described by thisOpenMBeanOperationInfoinstance.intgetImpact()Returns anintconstant qualifying the impact of the operation described by thisOpenMBeanOperationInfoinstance.StringgetName()Returns the name of the operation described by thisOpenMBeanOperationInfoinstance.OpenType<?>getReturnOpenType()Returns the open type of the values returned by the operation described by thisOpenMBeanOperationInfoinstance.StringgetReturnType()Returns the fully qualified Java class name of the values returned by the operation described by thisOpenMBeanOperationInfoinstance.MBeanParameterInfo[]getSignature()Returns an array ofOpenMBeanParameterInfoinstances describing each parameter in the signature of the operation described by thisOpenMBeanOperationInfoinstance.inthashCode()Returns the hash code value for thisOpenMBeanOperationInfoinstance.StringtoString()Returns a string representation of thisOpenMBeanOperationInfoinstance.
-
-
-
Method Detail
-
getDescription
String getDescription()
Returns a human readable description of the operation described by thisOpenMBeanOperationInfoinstance.- Returns:
- the description.
-
getName
String getName()
Returns the name of the operation described by thisOpenMBeanOperationInfoinstance.- Returns:
- the name.
-
getSignature
MBeanParameterInfo[] getSignature()
Returns an array ofOpenMBeanParameterInfoinstances describing each parameter in the signature of the operation described by thisOpenMBeanOperationInfoinstance. Each instance in the returned array should actually be a subclass ofMBeanParameterInfowhich implements theOpenMBeanParameterInfointerface (typicallyOpenMBeanParameterInfoSupport).- Returns:
- the signature.
-
getImpact
int getImpact()
Returns anintconstant qualifying the impact of the operation described by thisOpenMBeanOperationInfoinstance. The returned constant is one ofMBeanOperationInfo.INFO,MBeanOperationInfo.ACTION,MBeanOperationInfo.ACTION_INFO, orMBeanOperationInfo.UNKNOWN.- Returns:
- the impact code.
-
getReturnType
String getReturnType()
Returns the fully qualified Java class name of the values returned by the operation described by thisOpenMBeanOperationInfoinstance. This method should return the same value as a call togetReturnOpenType().getClassName().- Returns:
- the return type.
-
getReturnOpenType
OpenType<?> getReturnOpenType()
Returns the open type of the values returned by the operation described by thisOpenMBeanOperationInfoinstance.- Returns:
- the return type.
-
equals
boolean equals(Object obj)
Compares the specified obj parameter with thisOpenMBeanOperationInfoinstance for equality.Returns
trueif and only if all of the following statements are true:- obj is non null,
- obj also implements the
OpenMBeanOperationInfointerface, - their names are equal
- their signatures are equal
- their return open types are equal
- their impacts are equal
equalsmethod works properly for obj parameters which are different implementations of theOpenMBeanOperationInfointerface.
- Overrides:
equalsin classObject- Parameters:
obj- the object to be compared for equality with thisOpenMBeanOperationInfoinstance;- Returns:
trueif the specified object is equal to thisOpenMBeanOperationInfoinstance.- See Also:
Object.hashCode()
-
hashCode
int hashCode()
Returns the hash code value for thisOpenMBeanOperationInfoinstance.The hash code of an
OpenMBeanOperationInfoinstance is the sum of the hash codes of all elements of information used inequalscomparisons (ie: its name, return open type, impact and signature, where the signature hashCode is calculated by a call tojava.util.Arrays.asList(this.getSignature).hashCode()).This ensures that
t1.equals(t2)implies thatt1.hashCode()==t2.hashCode()for any twoOpenMBeanOperationInfoinstancest1andt2, as required by the general contract of the methodObject.hashCode().- Overrides:
hashCodein classObject- Returns:
- the hash code value for this
OpenMBeanOperationInfoinstance - See Also:
Object.equals(java.lang.Object)
-
toString
String toString()
Returns a string representation of thisOpenMBeanOperationInfoinstance.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.
-
-