javax.management.openmbean

Interface OpenMBeanInfo

Known Implementing Classes:
OpenMBeanInfoSupport

public interface OpenMBeanInfo

Describes an open management bean. Open management beans are management beans where DynamicMBean.getMBeanInfo() returns an implementation of this interface. This interface includes those methods specified by MBeanInfo, so implementations should extend this class. Each method which returns an array of one of the MBeanXXXInfo classes should return an array containing instances of the equivalent open version (OpenMBeanXXXInfo).
Since:
1.5

Method Summary

boolean
equals(Object obj)
Compares this attribute with the supplied object.
MBeanAttributeInfo[]
getAttributes()
Returns descriptions of each of the attributes provided by this management bean.
String
getClassName()
Returns the class name of the management bean.
MBeanConstructorInfo[]
getConstructors()
Returns descriptions of each of the constructors provided by this management bean.
String
getDescription()
Returns a description of this operation.
MBeanNotificationInfo[]
getNotifications()
Returns descriptions of each of the notifications provided by this management bean.
MBeanOperationInfo[]
getOperations()
Returns descriptions of each of the operations provided by this management bean.
int
hashCode()
Returns the hashcode of the bean information as the sum of the hashcodes of the class name and each array (calculated using java.util.HashSet(java.util.Arrays.asList(signature)).hashCode()).
String
toString()
Returns a textual representation of this instance.

Method Details

equals

public boolean equals(Object obj)
Compares this attribute with the supplied object. This returns true iff the object is an instance of OpenMBeanInfo with the same class name and equal instances of the info classes.
Overrides:
equals in interface Object
Parameters:
obj - the object to compare.
Returns:
true if the object is a OpenMBeanInfo instance, className.equals(object.getClassName()) and each info class has an equal in the other object.

getAttributes

public MBeanAttributeInfo[] getAttributes()
Returns descriptions of each of the attributes provided by this management bean. The elements should be implementations of the OpenMBeanAttributeInfo class.
Returns:
an array of OpenMBeanAttributeInfo objects, representing the attributes emitted by this management bean.

getClassName

public String getClassName()
Returns the class name of the management bean.
Returns:
the bean's class name.

getConstructors

public MBeanConstructorInfo[] getConstructors()
Returns descriptions of each of the constructors provided by this management bean. The elements should be implementations of the OpenMBeanConstructorInfo class.
Returns:
an array of OpenMBeanConstructorInfo objects, representing the constructors emitted by this management bean.

getDescription

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

getNotifications

public MBeanNotificationInfo[] getNotifications()
Returns descriptions of each of the notifications provided by this management bean. The elements should be implementations of the OpenMBeanNotificationInfo class.
Returns:
an array of OpenMBeanNotificationInfo objects, representing the notifications emitted by this management bean.

getOperations

public MBeanOperationInfo[] getOperations()
Returns descriptions of each of the operations provided by this management bean. The elements should be implementations of the OpenMBeanOperationInfo class.
Returns:
an array of OpenMBeanOperationInfo objects, representing the operations emitted by this management bean.

hashCode

public int hashCode()
Returns the hashcode of the bean information as the sum of the hashcodes of the class name and each array (calculated using java.util.HashSet(java.util.Arrays.asList(signature)).hashCode()).
Overrides:
hashCode in interface Object
Returns:
the hashcode of the bean information.

toString

public String toString()
Returns a textual representation of this instance. This is constructed using the class name (javax.management.openmbean.OpenMBeanInfo) along with the class name and textual representations of each array.
Overrides:
toString in interface Object
Returns:
a @link{java.lang.String} instance representing the instance in textual form.

OpenMBeanInfo.java -- Open typed info about a management bean. 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.