This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


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.


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

          Compare this MBeanFeatureInfo to another.
 String

          Returns the human-readable description of the feature.
 Descriptor

          Returns the descriptor for the feature.
 String

          Returns the name of the feature.
 int

          Returns a hash code value for the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

description

protected String description
The human-readable description of the feature. It is recommended that subclasses call {@link #getDescription} rather than reading this field, and that they not change it.

name

protected String name
The name of the feature. It is recommended that subclasses call {@link #getName} 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 {@code 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.
Method Detail

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 {@link #getName()}, {@link #getDescription()}, and {@link #getDescriptor()} values are equal (not necessarily identical) to those of this MBeanFeatureInfo.

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.

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

getName

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

Returns:
the name of the feature.

hashCode

public int hashCode()
Overrides:
hashCode in class Object


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.