javax.management

Class MBeanFeatureInfo

Implemented Interfaces:
Serializable
Known Direct Subclasses:
MBeanAttributeInfo, MBeanConstructorInfo, MBeanNotificationInfo, MBeanOperationInfo, MBeanParameterInfo

public class MBeanFeatureInfo
extends Object
implements Serializable

A general superclass for the description of features of management beans. This allows the user to access the feature dynamically, without knowing the details beforehand. The information is immutable as standard. Of course, subclasses may change this, but this behaviour is not recommended.
Since:
1.5
See Also:
Serialized Form

Field Summary

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

Constructor Summary

MBeanFeatureInfo(String name, String description)
Constructs a new MBeanFeatureInfo with the specified name and description.

Method Summary

boolean
equals(Object obj)
Compares this feature with the supplied object.
String
getDescription()
Returns a description of this feature.
String
getName()
Returns the name of this feature.
int
hashCode()
Returns the hashcode of the feature as the sum of the hashcodes of its name and description.
String
toString()
Returns a textual representation of this instance.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

description

protected String description
A description of the feature in human-readable form. Subclasses should access this via the getDescription() function rather than using the value directly.

name

protected String name
The name of the feature. Subclasses should access this via the getName() function rather than using the value directly.

Constructor Details

MBeanFeatureInfo

public MBeanFeatureInfo(String name,
                        String description)
Constructs a new MBeanFeatureInfo with the specified name and description.
Parameters:
name - the name of the management bean feature.
description - the description of the feature.

Method Details

equals

public boolean equals(Object obj)
Compares this feature with the supplied object. This returns true iff the object is an instance of MBeanFeatureInfo and Object.equals() returns true for a comparison of both the name and description of this feature with that of the specified object.
Overrides:
equals in interface Object
Parameters:
obj - the object to compare.
Returns:
true if the object is a MBeanFeatureInfo instance, name.equals(object.getName()) and description.equals(object.getDescription.

getDescription

public String getDescription()
Returns a description of this feature.
Returns:
a human-readable description.

getName

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

hashCode

public int hashCode()
Returns the hashcode of the feature as the sum of the hashcodes of its name and description.
Overrides:
hashCode in interface Object
Returns:
the hashcode of this feature.

toString

public String toString()
Returns a textual representation of this instance. This is constructed using the class name (javax.management.MBeanFeatureInfo) and the name and description of the feature.

As instances of this class are immutable, the return value is computed just once for each instance and reused throughout its life.

Overrides:
toString in interface Object
Returns:
a @link{java.lang.String} instance representing the instance in textual form.

MBeanFeatureInfo.java -- Information about a bean feature. Copyright (C) 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.