javax.management
Class MBeanFeatureInfo

java.lang.Object
  extended by javax.management.MBeanFeatureInfo
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
MBeanAttributeInfo, MBeanConstructorInfo, MBeanNotificationInfo, MBeanOperationInfo, MBeanParameterInfo

public class MBeanFeatureInfo
extends Object
implements Serializable

A general superclass for the description of features of management beans. This allows the user to access the feature dynamically, without knowing the details beforehand. The information is immutable as standard. Of course, subclasses may change this, but this behaviour is not recommended.

Since:
1.5
See Also:
Serialized Form

Field Summary
protected  String description
          A description of the feature in human-readable form.
protected  String name
          The name of the feature.
 
Constructor Summary
MBeanFeatureInfo(String name, String description)
          Constructs a new MBeanFeatureInfo with the specified name and description.
 
Method Summary
 boolean equals(Object obj)
          Compares this feature with the supplied object.
 String getDescription()
          Returns a description of this feature.
 String getName()
          Returns the name of this feature.
 int hashCode()
          Returns the hashcode of the feature as the sum of the hashcodes of its name and description.
 String toString()
           Returns a textual representation of this instance.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

description

protected String description
A description of the feature in human-readable form. Subclasses should access this via the getDescription() function rather than using the value directly.


name

protected String name
The name of the feature. Subclasses should access this via the getName() function rather than using the value directly.

Constructor Detail

MBeanFeatureInfo

public MBeanFeatureInfo(String name,
                        String description)
Constructs a new MBeanFeatureInfo with the specified name and description.

Parameters:
name - the name of the management bean feature.
description - the description of the feature.
Method Detail

equals

public boolean equals(Object obj)
Compares this feature with the supplied object. This returns true iff the object is an instance of MBeanFeatureInfo and Object#equals() returns true for a comparison of both the name and description of this feature with that of the specified object.

Overrides:
equals in class Object
Parameters:
obj - the object to compare.
Returns:
true if the object is a MBeanFeatureInfo instance, name.equals(object.getName()) and description.equals(object.getDescription.
See Also:
Object.hashCode()

getDescription

public String getDescription()
Returns a description of this feature.

Returns:
a human-readable description.

getName

public String getName()
Returns the name of this feature.

Returns:
the name of the feature.

hashCode

public int hashCode()
Returns the hashcode of the feature as the sum of the hashcodes of its name and description.

Overrides:
hashCode in class Object
Returns:
the hashcode of this feature.
See Also:
Object.equals(Object), System.identityHashCode(Object)

toString

public String toString()

Returns a textual representation of this instance. This is constructed using the class name (javax.management.MBeanFeatureInfo) and the name and description of the feature.

As instances of this class are immutable, the return value is computed just once for each instance and reused throughout its life.

Overrides:
toString in class Object
Returns:
a @link{java.lang.String} instance representing the instance in textual form.
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)