Class MBeanFeatureInfo

java.lang.Object
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:

  • Field Details

    • 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 Details

    • 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 Details

    • 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:

    • hashCode

      public int hashCode()
      Description copied from class: Object
      Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by HashMap.

      The general contract of hashCode is:

      • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
      • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
      • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
      Overrides:
      hashCode in class Object
      Returns:
      a hash code value for this object
      See Also: