Class MBeanFeatureInfo
- java.lang.Object
-
- javax.management.MBeanFeatureInfo
-
- All Implemented Interfaces:
- Serializable, DescriptorRead
- Direct Known Subclasses:
- MBeanAttributeInfo, MBeanConstructorInfo, MBeanNotificationInfo, MBeanOperationInfo, MBeanParameterInfo
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:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description protected String
description
The human-readable description of the feature.protected String
name
The name of the feature.
-
Constructor Summary
Constructors Constructor and Description MBeanFeatureInfo(String name, String description)
Constructs anMBeanFeatureInfo
object.MBeanFeatureInfo(String name, String description, Descriptor descriptor)
Constructs anMBeanFeatureInfo
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and 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.int
hashCode()
Returns a hash code value for the object.
-
-
-
Field Detail
name
protected String 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 callgetDescription()
rather than reading this field, and that they not change it.
-
Constructor Detail
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
public MBeanFeatureInfo(String name, String description, Descriptor descriptor)
Constructs anMBeanFeatureInfo
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.6
-
Method Detail
getName
public String 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
public Descriptor getDescriptor()
Returns the descriptor for the feature. Changing the returned value will have no affect on the original descriptor.- Specified by:
-
getDescriptor
in interfaceDescriptorRead
- Returns:
- a descriptor that is either immutable or a copy of the original.
- Since:
- 1.6
equals
public boolean equals(Object o)
Compare this MBeanFeatureInfo to another.- Overrides:
-
equals
in classObject
- Parameters:
-
o
- the object to compare to. - Returns:
-
true if and only if
o
is an MBeanFeatureInfo such that itsgetName()
,getDescription()
, andgetDescriptor()
values are equal (not necessarily identical) to those of this MBeanFeatureInfo. - See Also:
-
Object.hashCode()
,HashMap
hashCode
public int hashCode()
Description copied from class:Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided byHashMap
.The general contract of
hashCode
is:- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals(Object)
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
Object.equals(java.lang.Object)
method, then calling thehashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by class
Object
does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)- Overrides:
-
hashCode
in classObject
- Returns:
- a hash code value for this object.
- See Also:
-
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
-
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.