001    /*
002     * $Id: Description.java,v 1.3 2010/05/13 13:06:52 ninthbit Exp $
003     *
004     * Copyright (c) 2010 by Oliver Boehm
005     *
006     * Licensed under the Apache License, Version 2.0 (the "License");
007     * you may not use this file except in compliance with the License.
008     * You may obtain a copy of the License at
009     *
010     *   http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express orimplied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     *
018     * (c)reated 18.01.2010 by oliver (ob@oasd.de)
019     */
020    
021    package patterntesting.runtime.jmx;
022    
023    import java.lang.annotation.Documented;
024    import java.lang.annotation.ElementType;
025    import java.lang.annotation.Retention;
026    import java.lang.annotation.RetentionPolicy;
027    import java.lang.annotation.Target;
028    
029    /**
030     * With this annotation you can add a description to a MBean.
031     * This description will than appear in the 'jconsole' as DescriptorKey.
032     *
033     * @author oliver
034     * @since 1.0 (18.01.2010)
035     */
036    @Documented
037    @Target({ElementType.TYPE, ElementType.METHOD})
038    @Retention(RetentionPolicy.RUNTIME)
039    public @interface Description {
040    
041        /** the descripiton of a MBean, attribute or operation. */
042        String value();
043    
044    }
045