blob: 01f30c1db0497e147747499334a7b586d62af6d8 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Portions Copyright 2000-2004 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25/*
26 * @author IBM Corp.
27 *
28 * Copyright IBM Corp. 1999-2000. All rights reserved.
29 */
30
31package javax.management;
32
33/**
34 * This interface is used to gain access to descriptors of the Descriptor class
35 * which are associated with a JMX component, i.e. MBean, MBeanInfo,
36 * MBeanAttributeInfo, MBeanNotificationInfo,
37 * MBeanOperationInfo, MBeanParameterInfo.
38 * <P>
39 * ModelMBeans make extensive use of this interface in ModelMBeanInfo classes.
40 *
41 * @since 1.5
42 */
43public interface DescriptorAccess extends DescriptorRead
44{
45 /**
46 * Sets Descriptor (full replace).
47 *
48 * @param inDescriptor replaces the Descriptor associated with the
49 * component implementing this interface. If the inDescriptor is invalid for the
50 * type of Info object it is being set for, an exception is thrown. If the
51 * inDescriptor is null, then the Descriptor will revert to its default value
52 * which should contain, at a minimum, the descriptor name and descriptorType.
53 *
54 * @see #getDescriptor
55 */
56 public void setDescriptor(Descriptor inDescriptor);
57}