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
.
description, name
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.
|
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.
|
equals, getSignature, hashCode
getDescription, getName
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.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)
Descriptor
of the constructed object will include fields
contributed by any annotations on the Constructor
object that contain the DescriptorKey
meta-annotation.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.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 name, String description, MBeanParameterInfo[] signature)
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)
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.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 Object clone()
clone
in class MBeanConstructorInfo
Cloneable
public Descriptor getDescriptor()
getDescriptor
in interface DescriptorRead
getDescriptor
in class MBeanFeatureInfo
setDescriptor(javax.management.Descriptor)
public void setDescriptor(Descriptor inDescriptor)
setDescriptor
in interface DescriptorAccess
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.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".getDescriptor()
public String toString()
toString
in class MBeanConstructorInfo
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, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138