This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.management
class MBeanConstructorInfo

java.lang.Object extended by javax.management.MBeanFeatureInfo extended by javax.management.MBeanConstructorInfo
All Implemented Interfaces:
Serializable, Cloneable, DescriptorRead
Direct Known Subclasses:
ModelMBeanConstructorInfo, OpenMBeanConstructorInfoSupport

public class MBeanConstructorInfo
extends MBeanFeatureInfo
implements Cloneable

Describes a constructor exposed by an MBean. Instances of this class are immutable. Subclasses may be mutable but this is not recommended.


Field Summary
 
Fields inherited from class javax.management.MBeanFeatureInfo
description, name
 
Constructor Summary
MBeanConstructorInfo(String description, Constructor constructor)

          Constructs an MBeanConstructorInfo object.
MBeanConstructorInfo(String name, String description, MBeanParameterInfo[] signature)

          Constructs an MBeanConstructorInfo object.
MBeanConstructorInfo(String name, String description, MBeanParameterInfo[] signature, Descriptor descriptor)

          Constructs an MBeanConstructorInfo object.
 
Method Summary
 Object

          Returns a shallow clone of this instance.
 boolean

          Compare this MBeanConstructorInfo to another.
 MBeanParameterInfo[]

          Returns the list of parameters for this constructor.
 int

          
 String

          Returns a string representation of the object.
 
Methods inherited from class javax.management.MBeanFeatureInfo
equals, getDescription, getDescriptor, getName, hashCode
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MBeanConstructorInfo

public MBeanConstructorInfo(String description,
                            Constructor constructor)
Constructs an MBeanConstructorInfo object. The {@link Descriptor} of the constructed object will include fields contributed by any annotations on the {@code Constructor} object that contain the {@link DescriptorKey} meta-annotation.

Parameters:
description - A human readable description of the operation.
constructor - The java.lang.reflect.Constructor object describing the MBean constructor.

MBeanConstructorInfo

public MBeanConstructorInfo(String name,
                            String description,
                            MBeanParameterInfo[] signature)
Constructs an MBeanConstructorInfo object.

Parameters:
name - The name of the constructor.
description - A human readable description of the constructor.
signature - MBeanParameterInfo objects describing the parameters(arguments) of the constructor. This may be null with the same effect as a zero-length array.

MBeanConstructorInfo

public MBeanConstructorInfo(String name,
                            String description,
                            MBeanParameterInfo[] signature,
                            Descriptor descriptor)
Constructs an MBeanConstructorInfo object.

Parameters:
name - The name of the constructor.
description - A human readable description of the constructor.
signature - MBeanParameterInfo objects describing the parameters(arguments) of the constructor. This may be null with the same effect as a zero-length array.
descriptor - The descriptor for the constructor. This may be null which is equivalent to an empty descriptor.
Method Detail

clone

public Object clone()

Returns a shallow clone of this instance. The clone is obtained by simply calling super.clone(), thus calling the default native shallow cloning mechanism implemented by Object.clone(). No deeper cloning of any internal field is made.

Since this class is immutable, cloning is chiefly of interest to subclasses.

Overrides:
clone in class Object

equals

public boolean equals(Object o)
Compare this MBeanConstructorInfo to another.

Overrides:
equals in class MBeanFeatureInfo
Parameters:
o - the object to compare to.
Returns:
true if and only if o is an MBeanConstructorInfo such that its {@link #getName()}, {@link #getDescription()}, {@link #getSignature()}, and {@link #getDescriptor()} values are equal (not necessarily identical) to those of this MBeanConstructorInfo. Two signature arrays are equal if their elements are pairwise equal.

getSignature

public MBeanParameterInfo[] getSignature()

Returns the list of parameters for this constructor. Each parameter is described by an MBeanParameterInfo object.

The returned array is a shallow copy of the internal array, which means that it is a copy of the internal array of references to the MBeanParameterInfo objects but that each referenced MBeanParameterInfo object is not copied.

Returns:
An array of MBeanParameterInfo objects.

hashCode

public int hashCode()
Overrides:
hashCode in class MBeanFeatureInfo

toString

public String toString()
Overrides:
toString in class Object


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.