MBeanFeatureInfo (Java SE 15 & JDK 15) (original) (raw)
All Implemented Interfaces:
[Serializable](../../../java.base/java/io/Serializable.html "interface in java.io")
, [DescriptorRead](DescriptorRead.html "interface in javax.management")
Direct Known Subclasses:
[MBeanAttributeInfo](MBeanAttributeInfo.html "class in javax.management")
, [MBeanConstructorInfo](MBeanConstructorInfo.html "class in javax.management")
, [MBeanNotificationInfo](MBeanNotificationInfo.html "class in javax.management")
, [MBeanOperationInfo](MBeanOperationInfo.html "class in javax.management")
, [MBeanParameterInfo](MBeanParameterInfo.html "class in javax.management")
public class MBeanFeatureInfo extends Object implements Serializable, DescriptorRead
Provides general information for an MBean descriptor object. The feature described can be an attribute, an operation, a parameter, or a notification. Instances of this class are immutable. Subclasses may be mutable but this is not recommended.
Since:
1.5
See Also:
Field Summary
Fields
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 |
---|---|
MBeanFeatureInfo(String name,String description) | Constructs an MBeanFeatureInfo object. |
MBeanFeatureInfo(String name,String description,Descriptor descriptor) | Constructs an MBeanFeatureInfo object. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
boolean | equals(Object o) | Compare this MBeanFeatureInfo to another. |
String | getDescription() | Returns the human-readable description of the feature. |
Descriptor | getDescriptor() | Returns the descriptor for the feature. |
String | getName() | Returns the name of the feature. |
Field Details
name
The name of the feature. It is recommended that subclasses callgetName() rather than reading this field, and that they not change it.
description
protected String description
The human-readable description of the feature. It is recommended that subclasses call getDescription() rather than reading this field, and that they not change it.Constructor Details
MBeanFeatureInfo
public MBeanFeatureInfo(String name,String description)
Constructs anMBeanFeatureInfo
object. This constructor is equivalent toMBeanFeatureInfo(name, description, (Descriptor) null
.
Parameters:
name
- The name of the feature.
description
- A human readable description of the feature.MBeanFeatureInfo
Constructs an
MBeanFeatureInfo
object.
Parameters:
name
- The name of the feature.
description
- A human readable description of the feature.
descriptor
- The descriptor for the feature. This may be null which is equivalent to an empty descriptor.
Since:
1.6Method Details
getName
Returns the name of the feature.
Returns:
the name of the feature.getDescription
public String getDescription()
Returns the human-readable description of the feature.
Returns:
the human-readable description of the feature.getDescriptor
Returns the descriptor for the feature. Changing the returned value will have no affect on the original descriptor.
Specified by:
[getDescriptor](DescriptorRead.html#getDescriptor%28%29)
in interface[DescriptorRead](DescriptorRead.html "interface in javax.management")
Returns:
a descriptor that is either immutable or a copy of the original.
Since:
1.6equals
public boolean equals(Object o)
Compare this MBeanFeatureInfo to another.
Overrides:
[equals](../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29)
in class[Object](../../../java.base/java/lang/Object.html "class in java.lang")
Parameters:
o
- the object to compare to.
Returns:
true if and only ifo
is an MBeanFeatureInfo such that its getName(), getDescription(), andgetDescriptor() values are equal (not necessarily identical) to those of this MBeanFeatureInfo.
See Also:
Object.hashCode(), HashMap