Class 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

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.

Constructors

Constructor and Description
MBeanFeatureInfo(String name, String description)

Constructs an MBeanFeatureInfo object.
MBeanFeatureInfo(String name, String description, Descriptor descriptor)

Constructs an MBeanFeatureInfo object.

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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Fields

name

protected String name

The name of the feature. It is recommended that subclasses call getName() 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.

Constructors

MBeanFeatureInfo

public MBeanFeatureInfo(String name,
                        String description)

Constructs an MBeanFeatureInfo object. This constructor is equivalent to MBeanFeatureInfo(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 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.6

Methods

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 interface DescriptorRead
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 class Object
Parameters:
o - the object to compare to.
Returns:
true if and only if o is an MBeanFeatureInfo such that its getName(), getDescription(), and getDescriptor() 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 by HashMap.

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 in equals 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 the hashCode 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 the hashCode 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 class Object
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

© 1993, 2020, 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/javase/8/docs/api/javax/management/MBeanFeatureInfo.html