Class 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.
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:
Field Summary
Fields declared in class javax.management.MBeanFeatureInfo
description, name
Constructor Summary
Constructor | Description |
---|---|
ModelMBeanConstructorInfo |
Constructs a ModelMBeanConstructorInfo object with a default descriptor. |
ModelMBeanConstructorInfo |
Constructs a ModelMBeanConstructorInfo object. |
ModelMBeanConstructorInfo |
Constructs a ModelMBeanConstructorInfo object with a default descriptor. |
ModelMBeanConstructorInfo |
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 |
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 javax.management.MBeanConstructorInfo
equals, getSignature
Methods declared in class javax.management.MBeanFeatureInfo
getDescription, getName
Constructor Details
ModelMBeanConstructorInfo
public ModelMBeanConstructorInfo(String description, Constructor<?> constructorMethod)
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)
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)
- 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)
- 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()
- Overrides:
-
clone
in classMBeanConstructorInfo
- Returns:
- a clone of this instance.
- See Also:
getDescriptor
public Descriptor getDescriptor()
- Specified by:
-
getDescriptor
in interfaceDescriptorRead
- Overrides:
-
getDescriptor
in classMBeanFeatureInfo
- Returns:
- Descriptor associated with the ModelMBeanConstructorInfo object.
- See Also:
setDescriptor
public void setDescriptor(Descriptor inDescriptor)
- Specified by:
-
setDescriptor
in interfaceDescriptorAccess
- 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:
toString
public String toString()
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.management/javax/management/modelmbean/ModelMBeanConstructorInfo.html