001/*
002 * ============================================================================
003 * Copyright © 2002-2020 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 * Licensed to the public under the agreements of the GNU Lesser General Public
007 * License, version 3.0 (the "License"). You may obtain a copy of the License at
008 *
009 *      http://www.gnu.org/licenses/lgpl.html
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
013 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
014 * License for the specific language governing permissions and limitations
015 * under the License.
016 */
017
018package org.tquadrat.foundation.mgmt;
019
020import static org.apiguardian.api.API.Status.STABLE;
021
022import java.lang.annotation.Documented;
023import java.lang.annotation.ElementType;
024import java.lang.annotation.Inherited;
025import java.lang.annotation.Retention;
026import java.lang.annotation.RetentionPolicy;
027import java.lang.annotation.Target;
028
029import org.apiguardian.api.API;
030import org.tquadrat.foundation.annotation.ClassVersion;
031
032/**
033 *  This annotation will be used to mark a method as a getter method for an
034 *  MBean implementation.
035 *
036 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
037 *  @version $Id: MBeanGetter.java 995 2022-01-23 01:09:35Z tquadrat $
038 *  @since 0.0.1
039 */
040@ClassVersion( sourceVersion = "$Id: MBeanGetter.java 995 2022-01-23 01:09:35Z tquadrat $" )
041@API( status = STABLE, since = "0.0.1" )
042@Documented
043@Retention( RetentionPolicy.RUNTIME )
044@Target( ElementType.METHOD )
045@Inherited
046public @interface MBeanGetter
047{
048        /*------------*\
049    ====** Attributes **=======================================================
050        \*------------*/
051    /**
052     *  Returns the attribute's name.
053     *
054     *  @return The name of the attribute.
055     */
056    String attribute();
057
058    /**
059     *  Returns the description for the attribute.
060     *
061     *  @return The description.
062     */
063    String description() default "";
064}
065//  @interface MBeanGetter
066
067/*
068 *  End of File
069 */