javax.management
Class MBeanFeatureInfo

java.lang.Object
  |
  +--javax.management.MBeanFeatureInfo

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MBeanAttributeInfo, MBeanConstructorInfo, MBeanNotificationInfo, MBeanOperationInfo, MBeanParameterInfo

public class MBeanFeatureInfo

extends Object

implements Serializable

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.

See Also:

Serialized Form

Field Summary

protected String	description The human-readable description of the feature.
protected String	name The name of the feature.

Constructor Summary

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

Method Summary

boolean	equals(Object o) Compare this MBeanFeatureInfo to another.
String	getDescription() Returns the human-readable description of the feature.
String	getName() Returns the name of the feature.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

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.

Constructor Detail

MBeanFeatureInfo

public MBeanFeatureInfo(String name,
                        String description)
                 throws IllegalArgumentException

Constructs an MBeanFeatureInfo object.

Parameters:

name - The name of the feature.

description - A human readable description of the feature.

Throws:

IllegalArgumentException - if name is not a valid Java identifier. Java reserved words are not considered illegal here.

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.

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 iff o is an MBeanFeatureInfo such that its getName() and getDescription() values are equal (not necessarily identical) to those of this MBeanFeatureInfo.

hashCode

public int hashCode()

Overrides:

hashCode in class Object