1 /*

     2  * Copyright 2007-2008 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 package javax.management.openmbean;

    27 

    28 import java.lang.annotation.Documented;

    29 import java.lang.annotation.ElementType;

    30 import java.lang.annotation.Inherited;

    31 import java.lang.annotation.Retention;

    32 import java.lang.annotation.RetentionPolicy;

    33 import java.lang.annotation.Target;

    34 

    35 import javax.management.NotCompliantMBeanException;

    36 

    37 /**

    38  * Specifies the MXBean mapping to be used for this Java type.

    39  * @see MXBeanMapping

    40  */

    41 @Retention(RetentionPolicy.RUNTIME)

    42 @Target(ElementType.TYPE)

    43 @Documented @Inherited

    44 public @interface MXBeanMappingClass {

    45     /**

    46      * <p>The {@link MXBeanMapping} class to be used to map the

    47      * annotated type.  This class must have a public constructor with

    48      * a single argument of type {@link java.lang.reflect.Type}.  The

    49      * constructor will be called with the annotated type as an

    50      * argument.  See the {@code MXBeanMapping} documentation

    51      * for an example.</p>

    52      *

    53      * <p>If the {@code MXBeanMapping} cannot in fact handle that

    54      * type, the constructor should throw an {@link

    55      * OpenDataException}.  If the constructor throws this or any other

    56      * exception then an MXBean in which the annotated type appears is

    57      * invalid, and registering it in the MBean Server will produce a

    58      * {@link NotCompliantMBeanException}.

    59      */

    60     public Class<? extends MXBeanMapping> value();

    61 }