javax.management.modelmbean: public class: ModelMBeanConstructorInfo

javax.management.modelmbean
public class: ModelMBeanConstructorInfo [javadoc | source]

java.lang.Object
   javax.management.MBeanFeatureInfo
      javax.management.MBeanConstructorInfo
         javax.management.modelmbean.ModelMBeanConstructorInfo

All Implemented Interfaces:
DescriptorAccess, Cloneable, DescriptorRead, Serializable

The ModelMBeanConstructorInfo object describes a constructor of the ModelMBean. It is a subclass of MBeanConstructorInfo with the addition of an associated Descriptor and an implementation of the DescriptorAccess interface.

The fields in the descriptor are defined, but not limited to, the following. Note that when the Type in this table is Number, a String that is the decimal representation of a Long can also be used.

Name	Type	Meaning
name	String	Constructor name.
descriptorType	String	Must be "operation".
role	String	Must be "constructor".
displayName	String	Human readable name of constructor.
visibility	Number	1-4 where 1: always visible 4: rarely visible.
presentationString	String	XML formatted string to describe how to present operation

The {@code persistPolicy} and {@code currencyTimeLimit} fields are meaningless for constructors, but are not considered invalid.

The default descriptor will have the {@code name}, {@code descriptorType}, {@code displayName} and {@code role} fields.

The serialVersionUID of this class is 3862947819818064362L.

since: 1.5 -

Fields inherited from javax.management.MBeanConstructorInfo:
serialVersionUID, NO_CONSTRUCTORS

Fields inherited from javax.management.MBeanFeatureInfo:
serialVersionUID, name, description

Constructor:

Constructor:
ModelMBeanConstructorInfo(ModelMBeanConstructorInfo old) { super(old.getName(), old.getDescription(), old.getSignature()); if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) { MODELMBEAN_LOGGER.logp(Level.FINER, ModelMBeanConstructorInfo.class.getName(), "ModelMBeanConstructorInfo(" + "ModelMBeanConstructorInfo)", "Entry"); } consDescriptor = validDescriptor(consDescriptor); } Constructs a new ModelMBeanConstructorInfo object from this ModelMBeanConstructor Object. Parameters: `old` - the ModelMBeanConstructorInfo to be duplicated
public ModelMBeanConstructorInfo(String description, Constructor<?> constructorMethod) { super(description, constructorMethod); if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) { MODELMBEAN_LOGGER.logp(Level.FINER, ModelMBeanConstructorInfo.class.getName(), "ModelMBeanConstructorInfo(String,Constructor)", "Entry"); } consDescriptor = validDescriptor(null); // put getter and setter methods in constructors list // create default descriptor } Constructs a ModelMBeanConstructorInfo object with a default descriptor. The Descriptor of the constructed object will include fields contributed by any annotations on the {@code Constructor} object that contain the DescriptorKey meta-annotation. Parameters: `description` - A human readable description of the constructor. `constructorMethod` - The java.lang.reflect.Constructor object describing the MBean constructor.
public ModelMBeanConstructorInfo(String description, Constructor<?> constructorMethod, Descriptor descriptor) { super(description, constructorMethod); // put getter and setter methods in constructors list if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) { MODELMBEAN_LOGGER.logp(Level.FINER, ModelMBeanConstructorInfo.class.getName(), "ModelMBeanConstructorInfo(" + "String,Constructor,Descriptor)", "Entry"); } consDescriptor = validDescriptor(descriptor); } Constructs a ModelMBeanConstructorInfo object. The Descriptor of the constructed object will include fields contributed by any annotations on the {@code Constructor} object that contain the DescriptorKey meta-annotation. Parameters: `description` - A human readable description of the constructor. `constructorMethod` - The java.lang.reflect.Constructor object describing the ModelMBean constructor. `descriptor` - An instance of Descriptor containing the appropriate metadata for this instance of the ModelMBeanConstructorInfo. If it is null, then a default descriptor will be created. If the descriptor does not contain the field "displayName" this field is added in the descriptor with its default value. Throws: `RuntimeOperationsException` - Wraps an IllegalArgumentException. The descriptor is invalid, or descriptor field "name" is not equal to name parameter, or descriptor field "descriptorType" is not equal to "operation" or descriptor field "role" is present but not equal to "constructor". exception: `RuntimeOperationsException` - Wraps an IllegalArgumentException. The descriptor is invalid, or descriptor field "name" is not equal to name parameter, or descriptor field "descriptorType" is not equal to "operation" or descriptor field "role" is present but not equal to "constructor".
public ModelMBeanConstructorInfo(String name, String description, MBeanParameterInfo[] signature) { super(name, description, signature); // create default descriptor if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) { MODELMBEAN_LOGGER.logp(Level.FINER, ModelMBeanConstructorInfo.class.getName(), "ModelMBeanConstructorInfo(" + "String,String,MBeanParameterInfo[])", "Entry"); } consDescriptor = validDescriptor(null); } Constructs a ModelMBeanConstructorInfo object with a default descriptor. Parameters: `name` - The name of the constructor. `description` - A human readable description of the constructor. `signature` - MBeanParameterInfo object array describing the parameters(arguments) of the constructor.
public ModelMBeanConstructorInfo(String name, String description, MBeanParameterInfo[] signature, Descriptor descriptor) { super(name, description, signature); if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) { MODELMBEAN_LOGGER.logp(Level.FINER, ModelMBeanConstructorInfo.class.getName(), "ModelMBeanConstructorInfo(" + "String,String,MBeanParameterInfo[],Descriptor)", "Entry"); } consDescriptor = validDescriptor(descriptor); } Constructs a ModelMBeanConstructorInfo 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. `descriptor` - An instance of Descriptor containing the appropriate metadata for this instance of the MBeanConstructorInfo. If it is null then a default descriptor will be created. If the descriptor does not contain the field "displayName" this field is added in the descriptor with its default value. Throws: `RuntimeOperationsException` - Wraps an IllegalArgumentException. The descriptor is invalid, or descriptor field "name" is not equal to name parameter, or descriptor field "descriptorType" is not equal to "operation" or descriptor field "role" is present but not equal to "constructor". exception: `RuntimeOperationsException` - Wraps an IllegalArgumentException. The descriptor is invalid, or descriptor field "name" is not equal to name parameter, or descriptor field "descriptorType" is not equal to "operation" or descriptor field "role" is present but not equal to "constructor".

 ModelMBeanConstructorInfo(ModelMBeanConstructorInfo old) {
                super(old.getName(), old.getDescription(), old.getSignature());
                if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) {
                    MODELMBEAN_LOGGER.logp(Level.FINER,
                            ModelMBeanConstructorInfo.class.getName(),
                            "ModelMBeanConstructorInfo(" +
                            "ModelMBeanConstructorInfo)", "Entry");
                }
                consDescriptor = validDescriptor(consDescriptor);
}

Constructs a new ModelMBeanConstructorInfo object from this ModelMBeanConstructor Object.

Parameters:

old - the ModelMBeanConstructorInfo to be duplicated

 public ModelMBeanConstructorInfo(String description,
    Constructor<?> constructorMethod) {
                super(description, constructorMethod);
                if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) {
                    MODELMBEAN_LOGGER.logp(Level.FINER,
                            ModelMBeanConstructorInfo.class.getName(),
                            "ModelMBeanConstructorInfo(String,Constructor)",
                            "Entry");
                }
                consDescriptor = validDescriptor(null);
                // put getter and setter methods in constructors list
                // create default descriptor
}

Descriptor

DescriptorKey

Parameters:

description - A human readable description of the constructor.

constructorMethod - The java.lang.reflect.Constructor object describing the MBean constructor.

 public ModelMBeanConstructorInfo(String description,
    Constructor<?> constructorMethod,
    Descriptor descriptor) {
                super(description, constructorMethod);
                // put getter and setter methods in constructors list
                if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) {
                    MODELMBEAN_LOGGER.logp(Level.FINER,
                            ModelMBeanConstructorInfo.class.getName(),
                            "ModelMBeanConstructorInfo(" +
                            "String,Constructor,Descriptor)", "Entry");
                }
                consDescriptor = validDescriptor(descriptor);
}

Descriptor

DescriptorKey

Parameters:

description - A human readable description of the constructor.

constructorMethod - The java.lang.reflect.Constructor object describing the ModelMBean constructor.

descriptor - An instance of Descriptor containing the appropriate metadata for this instance of the ModelMBeanConstructorInfo. If it is null, then a default descriptor will be created. If the descriptor does not contain the field "displayName" this field is added in the descriptor with its default value.

Throws:

RuntimeOperationsException - Wraps an IllegalArgumentException. The descriptor is invalid, or descriptor field "name" is not equal to name parameter, or descriptor field "descriptorType" is not equal to "operation" or descriptor field "role" is present but not equal to "constructor".

exception: RuntimeOperationsException - Wraps an IllegalArgumentException. The descriptor is invalid, or descriptor field "name" is not equal to name parameter, or descriptor field "descriptorType" is not equal to "operation" or descriptor field "role" is present but not equal to "constructor".

 public ModelMBeanConstructorInfo(String name,
    String description,
    MBeanParameterInfo[] signature) {
                super(name, description, signature);
                // create default descriptor
                if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) {
                    MODELMBEAN_LOGGER.logp(Level.FINER,
                            ModelMBeanConstructorInfo.class.getName(),
                            "ModelMBeanConstructorInfo(" +
                            "String,String,MBeanParameterInfo[])", "Entry");
                }
                consDescriptor = validDescriptor(null);
}

Constructs a ModelMBeanConstructorInfo object with a default descriptor.

Parameters:

name - The name of the constructor.

description - A human readable description of the constructor.

signature - MBeanParameterInfo object array describing the parameters(arguments) of the constructor.

 public ModelMBeanConstructorInfo(String name,
    String description,
    MBeanParameterInfo[] signature,
    Descriptor descriptor) {
                super(name, description, signature);
                if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) {
                    MODELMBEAN_LOGGER.logp(Level.FINER,
                            ModelMBeanConstructorInfo.class.getName(),
                            "ModelMBeanConstructorInfo(" +
                            "String,String,MBeanParameterInfo[],Descriptor)",
                            "Entry");
                }
                consDescriptor = validDescriptor(descriptor);
}

Constructs a ModelMBeanConstructorInfo 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.

descriptor - An instance of Descriptor containing the appropriate metadata for this instance of the MBeanConstructorInfo. If it is null then a default descriptor will be created. If the descriptor does not contain the field "displayName" this field is added in the descriptor with its default value.

Throws:

Method from javax.management.modelmbean.ModelMBeanConstructorInfo Summary:
clone, getDescriptor, setDescriptor, toString

Methods from javax.management.MBeanConstructorInfo:
clone, equals, getSignature, hashCode, 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.modelmbean.ModelMBeanConstructorInfo Detail:
public Object clone() { if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) { MODELMBEAN_LOGGER.logp(Level.FINER, ModelMBeanConstructorInfo.class.getName(), "clone()", "Entry"); } return(new ModelMBeanConstructorInfo(this)) ; } Creates and returns a new ModelMBeanConstructorInfo which is a duplicate of this ModelMBeanConstructorInfo.
public Descriptor getDescriptor() { if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) { MODELMBEAN_LOGGER.logp(Level.FINER, ModelMBeanConstructorInfo.class.getName(), "getDescriptor()", "Entry"); } if (consDescriptor == null){ consDescriptor = validDescriptor(null); } return((Descriptor)consDescriptor.clone()); } Returns a copy of the associated Descriptor.
public void setDescriptor(Descriptor inDescriptor) { if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) { MODELMBEAN_LOGGER.logp(Level.FINER, ModelMBeanConstructorInfo.class.getName(), "setDescriptor()", "Entry"); } consDescriptor = validDescriptor(inDescriptor); } Sets associated Descriptor (full replace) of ModelMBeanConstructorInfo. If the new Descriptor is null, then the associated Descriptor reverts to a default descriptor. The Descriptor is validated before it is assigned. If the new Descriptor is invalid, then a RuntimeOperationsException wrapping an IllegalArgumentException is thrown.
public String toString() { if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) { MODELMBEAN_LOGGER.logp(Level.FINER, ModelMBeanConstructorInfo.class.getName(), "toString()", "Entry"); } String retStr = "ModelMBeanConstructorInfo: " + this.getName() + " ; Description: " + this.getDescription() + " ; Descriptor: " + this.getDescriptor() + " ; Signature: "; MBeanParameterInfo[] pTypes = this.getSignature(); for (int i=0; i < pTypes.length; i++) { retStr = retStr.concat((pTypes[i]).getType() + ", "); } return retStr; } Returns a string containing the entire contents of the ModelMBeanConstructorInfo in human readable form.

Method from javax.management.modelmbean.ModelMBeanConstructorInfo Detail:

 public Object clone() {
            if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) {
                MODELMBEAN_LOGGER.logp(Level.FINER,
                        ModelMBeanConstructorInfo.class.getName(),
                        "clone()", "Entry");
            }
                return(new ModelMBeanConstructorInfo(this)) ;
}

Creates and returns a new ModelMBeanConstructorInfo which is a duplicate of this ModelMBeanConstructorInfo.

 public Descriptor getDescriptor() {
            if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) {
                MODELMBEAN_LOGGER.logp(Level.FINER,
                        ModelMBeanConstructorInfo.class.getName(),
                        "getDescriptor()", "Entry");
            }
            if (consDescriptor == null){
                consDescriptor = validDescriptor(null);
            }
            return((Descriptor)consDescriptor.clone());
}

Returns a copy of the associated Descriptor.

 public  void setDescriptor(Descriptor inDescriptor) {
            if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) {
                MODELMBEAN_LOGGER.logp(Level.FINER,
                        ModelMBeanConstructorInfo.class.getName(),
                        "setDescriptor()", "Entry");
            }
            consDescriptor = validDescriptor(inDescriptor);
}

Sets associated Descriptor (full replace) of ModelMBeanConstructorInfo. If the new Descriptor is null, then the associated Descriptor reverts to a default descriptor. The Descriptor is validated before it is assigned. If the new Descriptor is invalid, then a RuntimeOperationsException wrapping an IllegalArgumentException is thrown.

 public String toString() {
            if (MODELMBEAN_LOGGER.isLoggable(Level.FINER)) {
                MODELMBEAN_LOGGER.logp(Level.FINER,
                        ModelMBeanConstructorInfo.class.getName(),
                        "toString()", "Entry");
            }
                String retStr =
                    "ModelMBeanConstructorInfo: " + this.getName() +
                    " ; Description: " + this.getDescription() +
                    " ; Descriptor: " + this.getDescriptor() +
                    " ; Signature: ";
                MBeanParameterInfo[] pTypes = this.getSignature();
                for (int i=0; i <  pTypes.length; i++)
                {
                        retStr = retStr.concat((pTypes[i]).getType() + ", ");
                }
                return retStr;
}

Returns a string containing the entire contents of the ModelMBeanConstructorInfo in human readable form.