OpenJDK 27 · javax.management.modelmbean.ModelMBeanConstructorInfo

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.

Modifier and Type	Field and Description
private Descriptor	consDescriptor
private static final String	currClass
private static final ObjectStreamField[]	serialPersistentFields
private static final long	serialVersionUID Hides javax.management.MBeanConstructorInfo.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	ModelMBeanConstructorInfo(String A human readable description of the constructor. description, Constructor<?> The java.lang.reflect.Constructor object describing the MBean constructor. constructorMethod) Constructs a ModelMBeanConstructorInfo object with a default descriptor.
public	ModelMBeanConstructorInfo(String A human readable description of the constructor. description, Constructor<?> The java.lang.reflect.Constructor object describing the ModelMBean constructor. constructorMethod, 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. descriptor) Constructs a ModelMBeanConstructorInfo object.
public	ModelMBeanConstructorInfo(String The name of the constructor. name, String A human readable description of the constructor. description, MBeanParameterInfo[] MBeanParameterInfo object array describing the parameters(arguments) of the constructor. signature) Constructs a ModelMBeanConstructorInfo object with a default descriptor.
public	ModelMBeanConstructorInfo(String The name of the constructor. name, String A human readable description of the constructor. description, MBeanParameterInfo[] MBeanParameterInfo objects describing the parameters(arguments) of the constructor. signature, 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. descriptor) Constructs a ModelMBeanConstructorInfo object.
pack-priv	ModelMBeanConstructorInfo(ModelMBeanConstructorInfo the ModelMBeanConstructorInfo to be duplicated old) Constructs a new ModelMBeanConstructorInfo object from this ModelMBeanConstructor Object.

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides javax.management.MBeanConstructorInfo.clone. Creates and returns a new ModelMBeanConstructorInfo which is a duplicate of this ModelMBeanConstructorInfo.
public Descriptor	Returns: Descriptor associated with the ModelMBeanConstructorInfo object. getDescriptor() Overrides javax.management.MBeanFeatureInfo.getDescriptor. Implements javax.management.DescriptorRead.getDescriptor. Returns a copy of the associated Descriptor.
private void	readObject(ObjectInputStream in) Hides javax.management.MBeanFeatureInfo.readObject. Deserializes a `ModelMBeanConstructorInfo` from an `ObjectInputStream`.
public void	setDescriptor(Descriptor 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. inDescriptor) Implements javax.management.DescriptorAccess.setDescriptor. Sets associated Descriptor (full replace) of ModelMBeanConstructorInfo.
public String	toString() Overrides javax.management.MBeanConstructorInfo.toString. Returns a string containing the entire contents of the ModelMBeanConstructorInfo in human readable form.
private Descriptor	validDescriptor(final Descriptor Descriptor to be checked, or null which is equivalent to an empty Descriptor. in) Clones the passed in Descriptor, sets default values, and checks for validity.
private void	writeObject(ObjectOutputStream out) Hides javax.management.MBeanFeatureInfo.writeObject. Serializes a `ModelMBeanConstructorInfo` to an `ObjectOutputStream`.

Inherited from javax.management.MBeanConstructorInfo:: equals getSignature hashCode

Field Detail

consDescriptor	back to summary
private Descriptor consDescriptor

currClass	back to summary
private static final String currClass

serialPersistentFields	back to summary
private static final ObjectStreamField[] serialPersistentFields Serial Fields: consDescriptor:`Descriptor` The `Descriptor` containing the metadata for this instance

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.management.MBeanConstructorInfo.serialVersionUID.

Constructor Detail

ModelMBeanConstructorInfo back to summary

ModelMBeanConstructorInfo	back to summary
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:String A human readable description of the constructor. constructorMethod:Constructor<?> The java.lang.reflect.Constructor object describing the MBean constructor.

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:String: A human readable description of the constructor.
constructorMethod:Constructor<?>: The java.lang.reflect.Constructor object describing the MBean constructor.

ModelMBeanConstructorInfo back to summary

ModelMBeanConstructorInfo	back to summary
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:String A human readable description of the constructor. constructorMethod:Constructor<?> The java.lang.reflect.Constructor object describing the ModelMBean constructor. descriptor: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. Exceptions 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 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:String: A human readable description of the constructor.
constructorMethod:Constructor<?>: The java.lang.reflect.Constructor object describing the ModelMBean constructor.
descriptor: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.

Exceptions

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	back to summary
public ModelMBeanConstructorInfo(String name, String description, MBeanParameterInfo[] signature) Constructs a ModelMBeanConstructorInfo object with a default descriptor. Parameters name:String The name of the constructor. description:String A human readable description of the constructor. signature:MBeanParameterInfo[] MBeanParameterInfo object array describing the parameters(arguments) of the constructor.

ModelMBeanConstructorInfo

back to summary

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

Constructs a ModelMBeanConstructorInfo object with a default descriptor.

Parameters

name:String: The name of the constructor.
description:String: A human readable description of the constructor.
signature:MBeanParameterInfo[]: MBeanParameterInfo object array describing the parameters(arguments) of the constructor.

ModelMBeanConstructorInfo	back to summary
public ModelMBeanConstructorInfo(String name, String description, MBeanParameterInfo[] signature, Descriptor descriptor) Constructs a ModelMBeanConstructorInfo object. Parameters name:String The name of the constructor. description:String A human readable description of the constructor. signature:MBeanParameterInfo[] MBeanParameterInfo objects describing the parameters(arguments) of the constructor. descriptor: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. Exceptions 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

back to summary

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

Constructs a ModelMBeanConstructorInfo object.

Parameters

name:String: The name of the constructor.
description:String: A human readable description of the constructor.
signature:MBeanParameterInfo[]: MBeanParameterInfo objects describing the parameters(arguments) of the constructor.
descriptor: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.

Exceptions

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	back to summary
pack-priv ModelMBeanConstructorInfo(ModelMBeanConstructorInfo old) Constructs a new ModelMBeanConstructorInfo object from this ModelMBeanConstructor Object. Parameters old:ModelMBeanConstructorInfo the ModelMBeanConstructorInfo to be duplicated

ModelMBeanConstructorInfo

back to summary

pack-priv ModelMBeanConstructorInfo(ModelMBeanConstructorInfo old)

Constructs a new ModelMBeanConstructorInfo object from this ModelMBeanConstructor Object.

Parameters

old:ModelMBeanConstructorInfo: the ModelMBeanConstructorInfo to be duplicated

Method Detail

clone	back to summary
public Object clone() Overrides javax.management.MBeanConstructorInfo.clone. Creates and returns a new ModelMBeanConstructorInfo which is a duplicate of this ModelMBeanConstructorInfo. Annotations @Override

clone

back to summary

public Object clone()

Overrides javax.management.MBeanConstructorInfo.clone.

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

Annotations

@Override

getDescriptor back to summary

getDescriptor	back to summary
public Descriptor getDescriptor() Overrides javax.management.MBeanFeatureInfo.getDescriptor. Implements javax.management.DescriptorRead.getDescriptor. Returns a copy of the associated Descriptor. Returns:Descriptor Descriptor associated with the ModelMBeanConstructorInfo object. Annotations @Override See Also `setDescriptor`

public Descriptor getDescriptor()

Overrides javax.management.MBeanFeatureInfo.getDescriptor.

Implements javax.management.DescriptorRead.getDescriptor.

Returns a copy of the associated Descriptor.

Returns:Descriptor

Descriptor associated with the ModelMBeanConstructorInfo object.

Annotations

@Override

See Also

setDescriptor

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException Hides javax.management.MBeanFeatureInfo.readObject. Deserializes a `ModelMBeanConstructorInfo` from an `ObjectInputStream`.

private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException

Hides javax.management.MBeanFeatureInfo.readObject.

Deserializes a ModelMBeanConstructorInfo from an ObjectInputStream.

setDescriptor back to summary

setDescriptor	back to summary
public void setDescriptor(Descriptor inDescriptor) Implements javax.management.DescriptorAccess.setDescriptor. 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:Descriptor 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. Exceptions 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`

public void setDescriptor(Descriptor inDescriptor)

Implements javax.management.DescriptorAccess.setDescriptor.

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

Exceptions

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	back to summary
public String toString() Overrides javax.management.MBeanConstructorInfo.toString. Returns a string containing the entire contents of the ModelMBeanConstructorInfo in human readable form. Annotations @Override

toString

back to summary

public String toString()

Overrides javax.management.MBeanConstructorInfo.toString.

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

Annotations

@Override

validDescriptor	back to summary
private Descriptor validDescriptor(final Descriptor in) throws RuntimeOperationsException Clones the passed in Descriptor, sets default values, and checks for validity. If the Descriptor is invalid (for instance by having the wrong "name"), this indicates programming error and a RuntimeOperationsException will be thrown. The following fields will be defaulted if they are not already set: displayName=this.getName(), name=this.getName(), descriptorType="operation", role="constructor" Parameters in:Descriptor Descriptor to be checked, or null which is equivalent to an empty Descriptor. Exceptions RuntimeOperationsException: if Descriptor is invalid

validDescriptor

back to summary

private Descriptor validDescriptor(final Descriptor in) throws RuntimeOperationsException

Clones the passed in Descriptor, sets default values, and checks for validity. If the Descriptor is invalid (for instance by having the wrong "name"), this indicates programming error and a RuntimeOperationsException will be thrown. The following fields will be defaulted if they are not already set: displayName=this.getName(), name=this.getName(), descriptorType="operation", role="constructor"

Parameters

in:Descriptor: Descriptor to be checked, or null which is equivalent to an empty Descriptor.

Exceptions

RuntimeOperationsException:: if Descriptor is invalid

writeObject back to summary

writeObject	back to summary
private void writeObject(ObjectOutputStream out) throws IOException Hides javax.management.MBeanFeatureInfo.writeObject. Serializes a `ModelMBeanConstructorInfo` to an `ObjectOutputStream`.

private void writeObject(ObjectOutputStream out) throws IOException

Hides javax.management.MBeanFeatureInfo.writeObject.

Serializes a ModelMBeanConstructorInfo to an ObjectOutputStream.

public Class ModelMBeanConstructorInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail