public class MBeanInfo extends Object implements Cloneable, Serializable
Describes the interface of a management bean. This allows the user to access the bean dynamically, without knowing the details of any of its attributes, operations, constructors or notifications beforehand. The information is immutable as standard. Of course, subclasses may change this, but this behaviour is not recommended.
The contents of this class, for standard management beans,
are dynamically compiled using reflection.
getClassName()
and getConstructors()
return the name of the class and its constructors, respectively.
This is much the same as could be obtained by reflection on the
bean. getAttributes()
and getOperations()
,
however, do something more in splitting the methods of the
class into two sets. Those of the form, getXXX
,
setXXX
and isXXX
are taken to be
the accessors and mutators of a series of attributes, with
XXX
being the attribute name. These are returned
by getAttributes()
and the Attribute
class can
be used to manipulate them. The remaining methods are classified
as operations and returned by getOperations()
.
Beans can also broadcast notifications. If the bean provides this
facility, by implementing the NotificationBroadcaster
interface, then an array of MBeanNotificationInfo
objects
may be obtained from getNotifications()
, which describe
the notifications emitted.
Model management beans and open management beans also supply an
instance of this class, as part of implementing the
DynamicMBean.getMBeanInfo()
method of DynamicMBean
.
Constructor and Description |
---|
MBeanInfo(String name,
String desc,
MBeanAttributeInfo[] attribs,
MBeanConstructorInfo[] cons,
MBeanOperationInfo[] ops,
MBeanNotificationInfo[] notifs)
Constructs a new
MBeanInfo using the supplied
class name and description with the given attributes,
operations, constructors and notifications. |
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Returns a shallow clone of the information.
|
boolean |
equals(Object obj)
Compares this feature 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 the management bean.
|
MBeanNotificationInfo[] |
getNotifications()
Returns descriptions of each of the notifications emitted
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 information as the sum of the
hashcode of the classname, description and each array.
|
String |
toString()
Returns a textual representation of this instance.
|
public MBeanInfo(String name, String desc, MBeanAttributeInfo[] attribs, MBeanConstructorInfo[] cons, MBeanOperationInfo[] ops, MBeanNotificationInfo[] notifs)
MBeanInfo
using the supplied
class name and description with the given attributes,
operations, constructors and notifications. The class
name does not have to actually specify a valid class that
can be loaded by the MBean server or class loader; it merely
has to be a syntactically correct class name. Any of the
arrays may be null
; this will be treated as if
an empty array was supplied. A copy of the arrays is
taken, so later changes have no effect.name
- the name of the class this instance describes.desc
- a description of the bean.attribs
- the attribute descriptions for the bean,
or null
.cons
- the constructor descriptions for the bean,
or null
.ops
- the operation descriptions for the bean,
or null
.notifs
- the notification descriptions for the bean,
or null
.public Object clone()
Object
implementation of
Object.clone()
. As the fields can not be
changed, this method is only really of interest to
subclasses which may add new mutable fields or make
the existing ones mutable.public boolean equals(Object obj)
MBeanInfo
and
Object#equals()
returns true for a comparison of the
class name and description, and the arrays each contain the same
elements in the same order (but one may be longer than the
other).equals
in class Object
obj
- the object to compare.MBeanInfo
instance,
className.equals(object.getClassName())
,
description.equals(object.getDescription())
and the corresponding elements of the arrays are
equal.Object.hashCode()
public MBeanAttributeInfo[] getAttributes()
MBeanAttributeInfo
class) are immutable.MBeanAttributeInfo
objects,
representing the attributes emitted by this
management bean.public String getClassName()
public MBeanConstructorInfo[] getConstructors()
MBeanConstructorInfo
class) are immutable.MBeanConstructorInfo
objects,
representing the constructors emitted by this
management bean.public String getDescription()
public MBeanNotificationInfo[] getNotifications()
MBeanNotificationInfo
class) are immutable.MBeanNotificationInfo
objects,
representing the notifications emitted by this
management bean.public MBeanOperationInfo[] getOperations()
MBeanOperationInfo
class) are immutable.MBeanOperationInfo
objects,
representing the operations emitted by this
management bean.public int hashCode()
hashCode
in class Object
Object.equals(Object)
,
System.identityHashCode(Object)
public String toString()
Returns a textual representation of this instance. This
is constructed using the class name
(javax.management.MBeanInfo
),
the name and description of the bean and the contents
of the four arrays.
As instances of this class are immutable, the return value is computed just once for each instance and reused throughout its life.
toString
in class Object
Object.getClass()
,
Object.hashCode()
,
Class.getName()
,
Integer.toHexString(int)