Home » openjdk-7 » javax » management » openmbean » [javadoc | source]
javax.management.openmbean
public class: OpenMBeanOperationInfoSupport [javadoc | source]
java.lang.Object
   javax.management.MBeanFeatureInfo
      javax.management.MBeanOperationInfo
         javax.management.openmbean.OpenMBeanOperationInfoSupport

All Implemented Interfaces:
    OpenMBeanOperationInfo, Cloneable, DescriptorRead, Serializable

Describes an operation of an Open MBean.
Field Summary
static final  long serialVersionUID     
Fields inherited from javax.management.MBeanOperationInfo:
serialVersionUID,  NO_OPERATIONS,  INFO,  ACTION,  ACTION_INFO,  UNKNOWN
Fields inherited from javax.management.MBeanFeatureInfo:
serialVersionUID,  name,  description
Constructor:
 public OpenMBeanOperationInfoSupport(String name,
    String description,
    OpenMBeanParameterInfo[] signature,
    OpenType<?> returnOpenType,
    int impact) 

    Constructs an {@code OpenMBeanOperationInfoSupport} instance, which describes the operation of a class of open MBeans, with the specified {@code name}, {@code description}, {@code signature}, {@code returnOpenType} and {@code impact}.

    The {@code signature} array parameter is internally copied, so that subsequent changes to the array referenced by {@code signature} have 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: use {@code SimpleType.VOID} for operations that return nothing.
    impact - must be one of {@code ACTION}, {@code ACTION_INFO}, {@code INFO}, or {@code UNKNOWN}.
    Throws:
    IllegalArgumentException - if {@code name} or {@code description} are null or empty string, or {@code returnOpenType} is null, or {@code impact} is not one of {@code ACTION}, {@code ACTION_INFO}, {@code INFO}, or {@code UNKNOWN}.
    ArrayStoreException - If {@code signature} is not an array of instances of a subclass of {@code MBeanParameterInfo}.
 public OpenMBeanOperationInfoSupport(String name,
    String description,
    OpenMBeanParameterInfo[] signature,
    OpenType<?> returnOpenType,
    int impact,
    Descriptor descriptor) 

    Constructs an {@code OpenMBeanOperationInfoSupport} instance, which describes the operation of a class of open MBeans, with the specified {@code name}, {@code description}, {@code signature}, {@code returnOpenType}, {@code impact}, and {@code descriptor}.

    The {@code signature} array parameter is internally copied, so that subsequent changes to the array referenced by {@code signature} have 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: use {@code SimpleType.VOID} for operations that return nothing.
    impact - must be one of {@code ACTION}, {@code ACTION_INFO}, {@code INFO}, or {@code UNKNOWN}.
    descriptor - The descriptor for the operation. This may be null, which is equivalent to an empty descriptor.
    Throws:
    IllegalArgumentException - if {@code name} or {@code description} are null or empty string, or {@code returnOpenType} is null, or {@code impact} is not one of {@code ACTION}, {@code ACTION_INFO}, {@code INFO}, or {@code UNKNOWN}.
    ArrayStoreException - If {@code signature} is not an array of instances of a subclass of {@code MBeanParameterInfo}.
    since: 1.6 -
Method from javax.management.openmbean.OpenMBeanOperationInfoSupport Summary:
equals,   getReturnOpenType,   hashCode,   toString
Methods from javax.management.MBeanOperationInfo:
clone,   equals,   getImpact,   getReturnType,   getSignature,   hashCode,   parameters,   toString
Methods from javax.management.MBeanFeatureInfo:
equals,   getDescription,   getDescriptor,   getName,   hashCode
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.management.openmbean.OpenMBeanOperationInfoSupport Detail:
 public boolean equals(Object obj) 

    Compares the specified {@code obj} parameter with this {@code OpenMBeanOperationInfoSupport} instance for equality.

    Returns {@code true} if and only if all of the following statements are true:

    • {@code obj} is non null,
    • {@code obj} also implements the {@code OpenMBeanOperationInfo} interface,
    • their names are equal
    • their signatures are equal
    • their return open types are equal
    • their impacts are equal
    This ensures that this {@code equals} method works properly for {@code obj} parameters which are different implementations of the {@code OpenMBeanOperationInfo} interface.
 public OpenType<?> getReturnOpenType() 
    Returns the open type of the values returned by the operation described by this {@code OpenMBeanOperationInfo} instance.
 public int hashCode() 

    Returns the hash code value for this {@code OpenMBeanOperationInfoSupport} instance.

    The hash code of an {@code OpenMBeanOperationInfoSupport} instance is the sum of the hash codes of all elements of information used in {@code equals} comparisons (ie: its name, return open type, impact and signature, where the signature hashCode is calculated by a call to {@code java.util.Arrays.asList(this.getSignature).hashCode()}).

    This ensures that {@code t1.equals(t2) } implies that {@code t1.hashCode()==t2.hashCode() } for any two {@code OpenMBeanOperationInfoSupport} instances {@code t1} and {@code t2}, as required by the general contract of the method Object.hashCode() .

    However, note that another instance of a class implementing the {@code OpenMBeanOperationInfo} interface may be equal to this {@code OpenMBeanOperationInfoSupport} instance as defined by #equals(java.lang.Object) , but may have a different hash code if it is calculated differently.

    As {@code OpenMBeanOperationInfoSupport} instances are immutable, the hash code for this instance is calculated once, on the first call to {@code hashCode}, and then the same value is returned for subsequent calls.

 public String toString() 

    Returns a string representation of this {@code OpenMBeanOperationInfoSupport} instance.

    The string representation consists of the name of this class (ie {@code 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 {@code OpenMBeanOperationInfoSupport} instances are immutable, the string representation for this instance is calculated once, on the first call to {@code toString}, and then the same value is returned for subsequent calls.