- java.lang.Object
-
- javax.management.MBeanFeatureInfo
-
- javax.management.MBeanOperationInfo
-
- javax.management.openmbean.OpenMBeanOperationInfoSupport
-
- All Implemented Interfaces:
Serializable,Cloneable,DescriptorRead,OpenMBeanOperationInfo
public class OpenMBeanOperationInfoSupport extends MBeanOperationInfo implements OpenMBeanOperationInfo
Describes an operation of an Open MBean.- Since:
- 1.5
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields declared in class javax.management.MBeanOperationInfo
ACTION, ACTION_INFO, INFO, UNKNOWN
-
Fields declared in class javax.management.MBeanFeatureInfo
description, name
-
-
Constructor Summary
Constructors Constructor Description OpenMBeanOperationInfoSupport(String name, String description, OpenMBeanParameterInfo[] signature, OpenType<?> returnOpenType, int impact)Constructs anOpenMBeanOperationInfoSupportinstance, which describes the operation of a class of open MBeans, with the specifiedname,description,signature,returnOpenTypeandimpact.OpenMBeanOperationInfoSupport(String name, String description, OpenMBeanParameterInfo[] signature, OpenType<?> returnOpenType, int impact, Descriptor descriptor)Constructs anOpenMBeanOperationInfoSupportinstance, which describes the operation of a class of open MBeans, with the specifiedname,description,signature,returnOpenType,impact, anddescriptor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)Compares the specifiedobjparameter with thisOpenMBeanOperationInfoSupportinstance for equality.OpenType<?>getReturnOpenType()Returns the open type of the values returned by the operation described by thisOpenMBeanOperationInfoinstance.inthashCode()Returns the hash code value for thisOpenMBeanOperationInfoSupportinstance.StringtoString()Returns a string representation of thisOpenMBeanOperationInfoSupportinstance.-
Methods declared in class javax.management.MBeanOperationInfo
clone, getImpact, getReturnType, getSignature
-
Methods declared in class javax.management.MBeanFeatureInfo
getDescription, getDescriptor, getName
-
Methods declared in interface javax.management.openmbean.OpenMBeanOperationInfo
getDescription, getImpact, getName, getReturnType, getSignature
-
-
-
-
Constructor Detail
-
OpenMBeanOperationInfoSupport
public OpenMBeanOperationInfoSupport(String name, String description, OpenMBeanParameterInfo[] signature, OpenType<?> returnOpenType, int impact)
Constructs an
OpenMBeanOperationInfoSupportinstance, which describes the operation of a class of open MBeans, with the specifiedname,description,signature,returnOpenTypeandimpact.The
signaturearray parameter is internally copied, so that subsequent changes to the array referenced bysignaturehave no effect on this instance.- Parameters:
name- cannot be a null or empty string.description- cannot be a null or empty string.signature- can be null or empty if there are no parameters to describe.returnOpenType- cannot be null: useSimpleType.VOIDfor operations that return nothing.impact- must be one ofACTION,ACTION_INFO,INFO, orUNKNOWN.- Throws:
IllegalArgumentException- ifnameordescriptionare null or empty string, orreturnOpenTypeis null, orimpactis not one ofACTION,ACTION_INFO,INFO, orUNKNOWN.ArrayStoreException- Ifsignatureis not an array of instances of a subclass ofMBeanParameterInfo.
-
OpenMBeanOperationInfoSupport
public OpenMBeanOperationInfoSupport(String name, String description, OpenMBeanParameterInfo[] signature, OpenType<?> returnOpenType, int impact, Descriptor descriptor)
Constructs an
OpenMBeanOperationInfoSupportinstance, which describes the operation of a class of open MBeans, with the specifiedname,description,signature,returnOpenType,impact, anddescriptor.The
signaturearray parameter is internally copied, so that subsequent changes to the array referenced bysignaturehave no effect on this instance.- Parameters:
name- cannot be a null or empty string.description- cannot be a null or empty string.signature- can be null or empty if there are no parameters to describe.returnOpenType- cannot be null: useSimpleType.VOIDfor operations that return nothing.impact- must be one ofACTION,ACTION_INFO,INFO, orUNKNOWN.descriptor- The descriptor for the operation. This may be null, which is equivalent to an empty descriptor.- Throws:
IllegalArgumentException- ifnameordescriptionare null or empty string, orreturnOpenTypeis null, orimpactis not one ofACTION,ACTION_INFO,INFO, orUNKNOWN.ArrayStoreException- Ifsignatureis not an array of instances of a subclass ofMBeanParameterInfo.- Since:
- 1.6
-
-
Method Detail
-
getReturnOpenType
public OpenType<?> getReturnOpenType()
Returns the open type of the values returned by the operation described by thisOpenMBeanOperationInfoinstance.- Specified by:
getReturnOpenTypein interfaceOpenMBeanOperationInfo- Returns:
- the return type.
-
equals
public boolean equals(Object obj)
Compares the specified
objparameter with thisOpenMBeanOperationInfoSupportinstance for equality.Returns
trueif and only if all of the following statements are true:objis non null,objalso implements theOpenMBeanOperationInfointerface,- their names are equal
- their signatures are equal
- their return open types are equal
- their impacts are equal
equalsmethod works properly forobjparameters which are different implementations of theOpenMBeanOperationInfointerface.- Specified by:
equalsin interfaceOpenMBeanOperationInfo- Overrides:
equalsin classMBeanOperationInfo- Parameters:
obj- the object to be compared for equality with thisOpenMBeanOperationInfoSupportinstance;- Returns:
trueif the specified object is equal to thisOpenMBeanOperationInfoSupportinstance.- See Also:
Object.hashCode()
-
hashCode
public int hashCode()
Returns the hash code value for this
OpenMBeanOperationInfoSupportinstance.The hash code of an
OpenMBeanOperationInfoSupportinstance 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 twoOpenMBeanOperationInfoSupportinstancest1andt2, as required by the general contract of the methodObject.hashCode().However, note that another instance of a class implementing the
OpenMBeanOperationInfointerface may be equal to thisOpenMBeanOperationInfoSupportinstance as defined byequals(java.lang.Object), but may have a different hash code if it is calculated differently.As
OpenMBeanOperationInfoSupportinstances are immutable, the hash code for this instance is calculated once, on the first call tohashCode, and then the same value is returned for subsequent calls.- Specified by:
hashCodein interfaceOpenMBeanOperationInfo- Overrides:
hashCodein classObject- Returns:
- the hash code value for this
OpenMBeanOperationInfoSupportinstance - See Also:
Object.equals(java.lang.Object)
-
toString
public String toString()
Returns a string representation of this
OpenMBeanOperationInfoSupportinstance.The string representation consists of the name of this class (ie
javax.management.openmbean.OpenMBeanOperationInfoSupport), and the name, signature, return open type and impact of the described operation and the string representation of its descriptor.As
OpenMBeanOperationInfoSupportinstances are immutable, the string representation for this instance is calculated once, on the first call totoString, and then the same value is returned for subsequent calls.- Specified by:
toStringin interfaceOpenMBeanOperationInfo- Overrides:
toStringin classObject- Returns:
- a string representation of this
OpenMBeanOperationInfoSupportinstance
-
-