| Prev Class | Next Class | Frames | No Frames |
| Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Objectjavax.management.MBeanInfo
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 Summary | |
| |
Method Summary | |
Object |
|
boolean | |
MBeanAttributeInfo[] |
|
String |
|
MBeanConstructorInfo[] |
|
String |
|
MBeanNotificationInfo[] |
|
MBeanOperationInfo[] |
|
int |
|
String |
|
Methods inherited from class java.lang.Object | |
clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait | |
public MBeanInfo(String name, String desc, MBeanAttributeInfo[] attribs, MBeanConstructorInfo[] cons, MBeanOperationInfo[] ops, MBeanNotificationInfo[] notifs)
Constructs a newMBeanInfousing 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 benull; this will be treated as if an empty array was supplied. A copy of the arrays is taken, so later changes have no effect.
- Parameters:
name- the name of the class this instance describes.desc- a description of the bean.attribs- the attribute descriptions for the bean, ornull.cons- the constructor descriptions for the bean, ornull.ops- the operation descriptions for the bean, ornull.notifs- the notification descriptions for the bean, ornull.
public Object clone()
Returns a shallow clone of the information. This is simply a new copy of each string and a clone of each array, which still references the same objects, as obtained by theObjectimplementation ofObject.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.
- Returns:
- a shallow clone of this
MBeanInfo.
public boolean equals(Object obj)
Compares this feature with the supplied object. This returns true iff the object is an instance ofMBeanInfoandObject.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).
- Parameters:
obj- the object to compare.
- Returns:
- true if the object is a
MBeanInfoinstance,className.equals(object.getClassName()),description.equals(object.getDescription())and the corresponding elements of the arrays are equal.
public MBeanAttributeInfo[] getAttributes()
Returns descriptions of each of the attributes provided by this management bean. The returned value is a shallow copy of the attribute array maintained by this instance. Hence, changing the elements of the returned array will not affect the attribute array, and the elements (instances of theMBeanAttributeInfoclass) are immutable.
- Returns:
- an array of
MBeanAttributeInfoobjects, representing the attributes emitted by this management bean.
public String getClassName()
Returns the class name of the management bean.
- Returns:
- the bean's class name.
public MBeanConstructorInfo[] getConstructors()
Returns descriptions of each of the constructors provided by this management bean. The returned value is a shallow copy of the constructor array maintained by this instance. Hence, changing the elements of the returned array will not affect the constructor array, and the elements (instances of theMBeanConstructorInfoclass) are immutable.
- Returns:
- an array of
MBeanConstructorInfoobjects, representing the constructors emitted by this management bean.
public String getDescription()
Returns a description of the management bean.
- Returns:
- the bean's description.
public MBeanNotificationInfo[] getNotifications()
Returns descriptions of each of the notifications emitted by this management bean. The returned value is a shallow copy of the notification array maintained by this instance. Hence, changing the elements of the returned array will not affect the notification array, and the elements (instances of theMBeanNotificationInfoclass) are immutable.
- Returns:
- an array of
MBeanNotificationInfoobjects, representing the notifications emitted by this management bean.
public MBeanOperationInfo[] getOperations()
Returns descriptions of each of the operations provided by this management bean. The returned value is a shallow copy of the operation array maintained by this instance. Hence, changing the elements of the returned array will not affect the operation array, and the elements (instances of theMBeanOperationInfoclass) are immutable.
- Returns:
- an array of
MBeanOperationInfoobjects, representing the operations emitted by this management bean.
public int hashCode()
Returns the hashcode of the information as the sum of the hashcode of the classname, description and each array.
- Returns:
- the hashcode of the information.
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.
- Returns:
- a @link{java.lang.String} instance representing the instance in textual form.