Class ModelMBeanConstructorInfo

java.lang.Object

javax.management.MBeanFeatureInfo

javax.management.MBeanConstructorInfo

javax.management.modelmbean.ModelMBeanConstructorInfo

All Implemented Interfaces:

Serializable, Cloneable, DescriptorAccess, DescriptorRead

public class ModelMBeanConstructorInfo
extends MBeanConstructorInfo
implements DescriptorAccess

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.

ModelMBeanConstructorInfo Fields

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 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.

Since:

1.5

See Also:

• Serialized Form

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
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.

Method Summary

Modifier and Type	Method	Description
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.

Methods declared in class MBeanConstructorInfo

equals, getSignature

Modifier and Type	Method	Description
boolean	equals(Object o)	Compare this MBeanConstructorInfo to another.
MBeanParameterInfo[]	getSignature()	Returns the list of parameters for this constructor.

Methods declared in class MBeanFeatureInfo

getDescription, getName

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

Methods declared in class Object

finalize, getClass, hashCode, 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. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Constructor Details

ModelMBeanConstructorInfo

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.

ModelMBeanConstructorInfo

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 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".

ModelMBeanConstructorInfo

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.

ModelMBeanConstructorInfo

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

Method Details

clone

public Object clone()

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

Overrides:

clone in class MBeanConstructorInfo

Returns:

Object a shallow copy of this object.

getDescriptor

public Descriptor getDescriptor()

Returns a copy of the associated Descriptor.

Specified by:

getDescriptor in interface DescriptorRead

Overrides:

getDescriptor in class MBeanFeatureInfo

Returns:

Descriptor associated with the ModelMBeanConstructorInfo object.

See Also:

• setDescriptor(Descriptor)

setDescriptor

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.

Specified by:

setDescriptor in interface DescriptorAccess

Parameters:

inDescriptor - replaces the Descriptor associated with the ModelMBeanConstructor. If the descriptor does not contain all the following fields, the missing ones are added with their default values: displayName, name, role, descriptorType.

Throws:

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

See Also:

• getDescriptor()

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

String a printable representation for the receiver.