1. /*

  2.  * @(#)file      DescriptorAccess.java

  3.  * @(#)author    IBM Corp.

  4.  * @(#)version   1.17

  5.  * @(#)lastedit      03/12/19

  6.  */

  7. /*

  8.  * Copyright IBM Corp. 1999-2000.  All rights reserved.

  9.  * 

  10.  * The program is provided "as is" without any warranty express or implied,

  11.  * including the warranty of non-infringement and the implied warranties of

  12.  * merchantibility and fitness for a particular purpose. IBM will not be

  13.  * liable for any damages suffered by you or any third party claim against 

  14.  * you regarding the Program.

  15.  *

  16.  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.

  17.  * This software is the proprietary information of Sun Microsystems, Inc.

  18.  * Use is subject to license terms.

  19.  * 

  20.  * Copyright 2004 Sun Microsystems, Inc.  Tous droits reserves.

  21.  * Ce logiciel est propriete de Sun Microsystems, Inc.

  22.  * Distribue par des licences qui en restreignent l'utilisation. 

  23.  *

  24.  */

  25. 

  26. 

  27. package javax.management;

  28. 

  29. 

  30. /**

  31.  * This interface is used to gain access to descriptors of the Descriptor class 

  32.  * which are associated with a JMX component, i.e. MBean, MBeanInfo, 

  33.  * MBeanAttributeInfo, MBeanNotificationInfo,

  34.  * MBeanOperationInfo, MBeanParameterInfo.

  35.  * <P>

  36.  * ModelMBeans make extensive use of this interface in ModelMBeanInfo classes.

  37.  *

  38.  * @since 1.5

  39.  */

  40. public interface DescriptorAccess

  41. {

  42.     /** 

  43.     * Returns a copy of Descriptor.

  44.     *

  45.     * @return Descriptor associated with the component implementing this interface.

  46.     * Null should never be returned. At a minimum a default descriptor with the 

  47.     * descriptor name and descriptorType should be returned.

  48.     *

  49.     * @see #setDescriptor

  50.     */

  51.     public Descriptor getDescriptor();

  52.     

  53.     /**

  54.     * Sets Descriptor (full replace).

  55.     *

  56.     * @param inDescriptor replaces the Descriptor associated with the 

  57.     * component implementing this interface. If the inDescriptor is invalid for the

  58.     * type of Info object it is being set for, an exception is thrown.  If the

  59.     * inDescriptor is null, then the Descriptor will revert to its default value

  60.     * which should contain, at a minimum, the descriptor name and descriptorType.

  61.     * 

  62.     * @see #getDescriptor

  63.     */

  64.     public void setDescriptor(Descriptor inDescriptor);

  65. }