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.
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
andcurrencyTimeLimit
fields are meaningless for constructors, but are not considered invalid.The default descriptor will have the
name
,descriptorType
,displayName
androle
fields.The serialVersionUID of this class is
3862947819818064362L
.- Since:
- 1.5
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class javax.management.MBeanFeatureInfo
description, name
-
-
Constructor Summary
Constructors Constructor and 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
All Methods Instance Methods Concrete Methods Modifier and Type Method and 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 inherited from class javax.management.MBeanConstructorInfo
equals, getSignature, hashCode
-
Methods inherited from class javax.management.MBeanFeatureInfo
getDescription, getName
-
-
-
-
Constructor Detail
ModelMBeanConstructorInfo
public ModelMBeanConstructorInfo(String description, Constructor<?> constructorMethod)
Constructs a ModelMBeanConstructorInfo object with a default descriptor. TheDescriptor
of the constructed object will include fields contributed by any annotations on theConstructor
object that contain theDescriptorKey
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. TheDescriptor
of the constructed object will include fields contributed by any annotations on theConstructor
object that contain theDescriptorKey
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 Detail
clone
public Object clone()
Creates and returns a new ModelMBeanConstructorInfo which is a duplicate of this ModelMBeanConstructorInfo.- Overrides:
-
clone
in classMBeanConstructorInfo
- Returns:
- a clone of this instance.
- See Also:
-
Cloneable
getDescriptor
public Descriptor getDescriptor()
Returns a copy of the associated Descriptor.- Specified by:
-
getDescriptor
in interfaceDescriptorRead
- Overrides:
-
getDescriptor
in classMBeanFeatureInfo
- Returns:
- Descriptor associated with the ModelMBeanConstructorInfo object.
- See Also:
-
setDescriptor(javax.management.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 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:
-
getDescriptor()
toString
public String toString()
Returns a string containing the entire contents of the ModelMBeanConstructorInfo in human readable form.- Overrides:
-
toString
in classMBeanConstructorInfo
- Returns:
- a string representation of the object.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.