public class

MBeanFeatureInfo

extends Object
implements Serializable DescriptorRead
java.lang.Object
   ↳ javax.management.MBeanFeatureInfo
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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.

Summary

Fields
protected String description The human-readable description of the feature.
protected String name The name of the feature.
Public Constructors
MBeanFeatureInfo(String name, String description)
Constructs an MBeanFeatureInfo object.
MBeanFeatureInfo(String name, String description, Descriptor descriptor)
Constructs an MBeanFeatureInfo object.
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface javax.management.DescriptorRead

Fields

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.

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.

Public Constructors

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.

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.

Public Methods

public boolean equals (Object o)

Compare this MBeanFeatureInfo to another.

Parameters
o the object to compare to.
Returns

public String getDescription ()

Returns the human-readable description of the feature.

Returns
  • the human-readable description of the feature.

public Descriptor getDescriptor ()

Returns the descriptor for the feature. Changing the returned value will have no affect on the original descriptor.

Returns
  • a descriptor that is either immutable or a copy of the original.

public String getName ()

Returns the name of the feature.

Returns
  • the name of the feature.

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

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 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 hashtables.

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 JavaTM programming language.)

Returns
  • a hash code value for this object.