DescriptorAccess (Java 2 Platform Ent. Ed. v1.4) - Java Platform, Enterprise Edition v1.4 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Ent. Ed. v1.4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management
Interface DescriptorAccess

All Known Implementing Classes:: ModelMBeanAttributeInfo, ModelMBeanConstructorInfo, ModelMBeanNotificationInfo, ModelMBeanOperationInfo

public interface DescriptorAccess

This interface is used to gain access to descriptors of the Descriptor class which are associated with a JMX component, i.e. MBean, MBeanInfo, MBeanAttributeInfo, MBeanNotificationInfo, MBeanOperationInfo, MBeanParameterInfo.

ModelMBeans make extensive use of this interface in ModelMBeanInfo classes.

Method Summary

Descriptor getDescriptor()
Returns a copy of Descriptor.

void setDescriptor(Descriptor inDescriptor)
Sets Descriptor (full replace).

Method Detail

getDescriptor

public Descriptor getDescriptor()

Returns a copy of Descriptor.

Returns:: Descriptor associated with the component implementing this interface. Null should never be returned. At a minimum a default descriptor with the descriptor name and descriptorType should be returned.
See Also:: setDescriptor(javax.management.Descriptor)

setDescriptor

public void setDescriptor(Descriptor inDescriptor)

Sets Descriptor (full replace).

Parameters:: inDescriptor - replaces the Descriptor associated with the component implementing this interface. If the inDescriptor is invalid for the type of Info object it is being set for, an exception is thrown. If the inDescriptor is null, then the Descriptor will revert to its default value which should contain, at a minimum, the descriptor name and descriptorType.
See Also:: getDescriptor()