Java™ Platform
Standard Ed. 6

javax.management
Class MBeanFeatureInfo

java.lang.Object
  extended by javax.management.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

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.
MBeanFeatureInfo(String name, String description, Descriptor descriptor)
          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.
 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
 

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

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(), Hashtable

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 hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

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

Overrides:
hashCode in class Object
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object), Hashtable

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.