javax.management
Class MBeanFeatureInfo

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

Direct Known Subclasses:

MBeanAttributeInfo, MBeanConstructorInfo, MBeanNotificationInfo, MBeanOperationInfo, MBeanParameterInfo

public class MBeanFeatureInfo

extends java.lang.Object

implements java.io.Serializable

The MBeanFeatureInfo object provides general information for an MBean feature: The feature can be

an attribute,

an operation,

a parameter,

a returned value or

a notification.

See Also:

Serialized Form

Field Summary

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

Constructor Summary

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

Method Summary

boolean	equals(java.lang.Object obj) Compare this MBeanFeatureInfo to another.
java.lang.String	getDescription() Returns the human-readable description of the feature.
java.lang.String	getName() Returns the name of the feature.
int	hashCode() Returns the hash code value for this instance.
java.lang.String	toString() Returns a human readable version of the MBeanFeatureInfo instance

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.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 java.lang.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(java.lang.String name,
                        java.lang.String description)
                 throws java.lang.IllegalArgumentException

Constructs an MBeanFeatureInfo object.

Parameters:

name - The name of the feature.

description - A human readable description of the feature.

Throws:

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

Method Detail

getDescription

public java.lang.String getDescription()

Returns the human-readable description of the feature.

Returns:

the human-readable description of the feature.

getName

public java.lang.String getName()

Returns the name of the feature.

Returns:

the name of the feature.

equals

public boolean equals(java.lang.Object obj)

Compare this MBeanFeatureInfo to another.

Overrides:

equals in class java.lang.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()

Returns the hash code value for this instance.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode for this instance

toString

public java.lang.String toString()

Returns a human readable version of the MBeanFeatureInfo instance

Overrides:

toString in class java.lang.Object

Returns:

MBeanFeatrueInfo is returned in a human readable form (i.e) as a String