public class

ModelMBeanConstructorInfo

extends MBeanConstructorInfo
implements DescriptorAccess
java.lang.Object
   ↳ javax.management.MBeanFeatureInfo
     ↳ javax.management.MBeanConstructorInfo
       ↳ javax.management.modelmbean.ModelMBeanConstructorInfo

Class Overview

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: 

 name           : constructor name
 descriptorType : must be "operation"
 role           : must be "constructor"
 displayName    : human readable name of constructor
 visibility            : 1-4 where 1: always visible 4: rarely visible
 presentationString :  xml formatted string to describe how to present operation

The persistPolicy and currencyTimeLimit fields are meaningless for constructors, but are not considered invalid.

The default descriptor will have the name, descriptorType, displayName and role fields.

The serialVersionUID of this class is 3862947819818064362L.

Summary

[Expand]
Inherited Fields
From class javax.management.MBeanFeatureInfo
Public Constructors
ModelMBeanConstructorInfo(String description, Constructor constructorMethod)
Constructs a ModelMBeanConstructorInfo object with a default descriptor.
ModelMBeanConstructorInfo(String description, Constructor constructorMethod, Descriptor descriptor)
Constructs a ModelMBeanConstructorInfo object.
ModelMBeanConstructorInfo(String name, String description, MBeanParameterInfo[] signature)
Constructs a ModelMBeanConstructorInfo object with a default descriptor.
ModelMBeanConstructorInfo(String name, String description, MBeanParameterInfo[] signature, Descriptor descriptor)
Constructs a ModelMBeanConstructorInfo object.
Public Methods
Object clone()
Creates and returns a new ModelMBeanConstructorInfo which is a duplicate of this ModelMBeanConstructorInfo.
Descriptor getDescriptor()
Returns a copy of the associated Descriptor.
void setDescriptor(Descriptor inDescriptor)
Sets associated Descriptor (full replace) of ModelMBeanConstructorInfo.
String toString()
Returns a string containing the entire contents of the ModelMBeanConstructorInfo in human readable form.
[Expand]
Inherited Methods
From class javax.management.MBeanConstructorInfo
From class javax.management.MBeanFeatureInfo
From class java.lang.Object
From interface javax.management.DescriptorAccess
From interface javax.management.DescriptorRead

Public Constructors

public ModelMBeanConstructorInfo (String description, Constructor constructorMethod)

Constructs a ModelMBeanConstructorInfo object with a default descriptor. The Descriptor of the constructed object will include fields contributed by any annotations on the 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)

Constructs a ModelMBeanConstructorInfo object. The Descriptor of the constructed object will include fields contributed by any annotations on the 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 fields 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 not equal to "constructor".

public ModelMBeanConstructorInfo (String name, String description, MBeanParameterInfo[] signature)

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)

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 not equal to "constructor".

Public Methods

public Object clone ()

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

Returns
  • a clone of this instance.

public Descriptor getDescriptor ()

Returns a copy of the associated Descriptor.

Returns
  • Descriptor associated with the ModelMBeanConstructorInfo object.
See Also

public void setDescriptor (Descriptor 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.

Parameters
inDescriptor replaces the Descriptor associated with the ModelMBeanConstructor. 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 not equal to "constructor".
See Also

public String toString ()

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

Returns
  • a string representation of the object.