Class OpenMBeanConstructorInfoSupport

java.lang.Object
javax.management.MBeanFeatureInfo
javax.management.MBeanConstructorInfo
javax.management.openmbean.OpenMBeanConstructorInfoSupport
All Implemented Interfaces:
Serializable, Cloneable, DescriptorRead, OpenMBeanConstructorInfo
public class OpenMBeanConstructorInfoSupport extends MBeanConstructorInfo implements OpenMBeanConstructorInfo
Describes a constructor of an Open MBean.
Since:
1.5
See Also:

  • Field Summary

    Fields declared in class MBeanFeatureInfo

    description, name
    Modifier and Type
    Field
    Description
    protected String
    description
    The human-readable description of the feature.
    protected String
    name
    The name of the feature.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenMBeanConstructorInfoSupport(String name, String description, OpenMBeanParameterInfo[] signature)
    Constructs an OpenMBeanConstructorInfoSupport instance, which describes the constructor of a class of open MBeans with the specified name, description and signature.
    OpenMBeanConstructorInfoSupport(String name, String description, OpenMBeanParameterInfo[] signature, Descriptor descriptor)
    Constructs an OpenMBeanConstructorInfoSupport instance, which describes the constructor of a class of open MBeans with the specified name, description, signature, and descriptor.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    Compares the specified obj parameter with this OpenMBeanConstructorInfoSupport instance for equality.
    int
    hashCode()
    Returns the hash code value for this OpenMBeanConstructorInfoSupport instance.
    String
    toString()
    Returns a string representation of this OpenMBeanConstructorInfoSupport instance.

    Methods declared in class MBeanConstructorInfo

    clone, getSignature
    Modifier and Type
    Method
    Description
    Object
    clone()
    Returns a shallow clone of this instance.
    MBeanParameterInfo[]
    getSignature()
    Returns the list of parameters for this constructor.

    Methods declared in class MBeanFeatureInfo

    getDescription, getDescriptor, getName
    Modifier and Type
    Method
    Description
    String
    getDescription()
    Returns the human-readable description of the feature.
    Descriptor
    getDescriptor()
    Returns the descriptor for the feature.
    String
    getName()
    Returns the name of the feature.

    Methods declared in class Object

    finalize, getClass, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finalization is deprecated and subject to removal in a future release.
    final Class<?>
    getClass()
    Returns the runtime class of this Object.
    final void
    notify()
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    notifyAll()
    Wakes up all threads that are waiting on this object's monitor.
    final void
    wait()
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
    final void
    wait(long timeoutMillis)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
    final void
    wait(long timeoutMillis, int nanos)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

    Methods declared in interface OpenMBeanConstructorInfo

    getDescription, getName, getSignature
    Modifier and Type
    Method
    Description
    String
    getDescription()
    Returns a human readable description of the constructor described by this OpenMBeanConstructorInfo instance.
    String
    getName()
    Returns the name of the constructor described by this OpenMBeanConstructorInfo instance.
    MBeanParameterInfo[]
    getSignature()
    Returns an array of OpenMBeanParameterInfo instances describing each parameter in the signature of the constructor described by this OpenMBeanConstructorInfo instance.

  • Constructor Details

    • OpenMBeanConstructorInfoSupport

      public OpenMBeanConstructorInfoSupport(String name, String description, OpenMBeanParameterInfo[] signature)

      Constructs an OpenMBeanConstructorInfoSupport instance, which describes the constructor of a class of open MBeans with the specified name, description and signature.

      The signature array parameter is internally copied, so that subsequent changes to the array referenced by 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.
      Throws:
      IllegalArgumentException - if name or description are null or empty string.
      ArrayStoreException - If signature is not an array of instances of a subclass of MBeanParameterInfo.

    • OpenMBeanConstructorInfoSupport

      public OpenMBeanConstructorInfoSupport(String name, String description, OpenMBeanParameterInfo[] signature, Descriptor descriptor)

      Constructs an OpenMBeanConstructorInfoSupport instance, which describes the constructor of a class of open MBeans with the specified name, description, signature, and descriptor.

      The signature array parameter is internally copied, so that subsequent changes to the array referenced by 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.
      descriptor - The descriptor for the constructor. This may be null which is equivalent to an empty descriptor.
      Throws:
      IllegalArgumentException - if name or description are null or empty string.
      ArrayStoreException - If signature is not an array of instances of a subclass of MBeanParameterInfo.
      Since:
      1.6

  • Method Details

    • equals

      public boolean equals(Object obj)

      Compares the specified obj parameter with this OpenMBeanConstructorInfoSupport instance for equality.

      Returns true if and only if all of the following statements are true:

      • obj is non null,
      • obj also implements the OpenMBeanConstructorInfo interface,
      • their names are equal
      • their signatures are equal.
      This ensures that this equals method works properly for obj parameters which are different implementations of the OpenMBeanConstructorInfo interface.
      Specified by:
      equals in interface OpenMBeanConstructorInfo
      Overrides:
      equals in class MBeanConstructorInfo
      Parameters:
      obj - the object to be compared for equality with this OpenMBeanConstructorInfoSupport instance;
      Returns:
      true if the specified object is equal to this OpenMBeanConstructorInfoSupport instance.
      See Also:

    • hashCode

      public int hashCode()

      Returns the hash code value for this OpenMBeanConstructorInfoSupport instance.

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

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

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

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

      Specified by:
      hashCode in interface OpenMBeanConstructorInfo
      Overrides:
      hashCode in class Object
      Returns:
      the hash code value for this OpenMBeanConstructorInfoSupport instance
      See Also:

    • toString

      public String toString()

      Returns a string representation of this OpenMBeanConstructorInfoSupport instance.

      The string representation consists of the name of this class (ie javax.management.openmbean.OpenMBeanConstructorInfoSupport), the name and signature of the described constructor and the string representation of its descriptor.

      As OpenMBeanConstructorInfoSupport instances are immutable, the string representation for this instance is calculated once, on the first call to toString, and then the same value is returned for subsequent calls.

      Specified by:
      toString in interface OpenMBeanConstructorInfo
      Overrides:
      toString in class Object
      Returns:
      a string representation of this OpenMBeanConstructorInfoSupport instance