001/*
002 * ============================================================================
003 * Copyright © 2002-2022 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.Repeatable;
026import java.lang.annotation.Retention;
027import java.lang.annotation.RetentionPolicy;
028import java.lang.annotation.Target;
029
030import org.apiguardian.api.API;
031import org.tquadrat.foundation.annotation.ClassVersion;
032
033/**
034 *  {@summary This annotation will be used to declare a MBean notification.} If
035 *  a class is annotated, it means that at least one method of this class may
036 *  send this notification. Is the annotated component a method, it means that
037 *  this method is sending the notification.
038 *
039 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
040 *  @version $Id: MBeanNotification.java 995 2022-01-23 01:09:35Z tquadrat $
041 *  @since 0.0.1
042 *
043 *  @UMLGraph.link
044 */
045@API( status = STABLE, since = "0.0.1" )
046@Repeatable( MBeanNotifications.class )
047@Documented
048@Retention( RetentionPolicy.RUNTIME )
049@Target( {ElementType.TYPE, ElementType.METHOD} )
050@Inherited
051@ClassVersion( sourceVersion = "$Id: MBeanNotification.java 995 2022-01-23 01:09:35Z tquadrat $" )
052public @interface MBeanNotification
053{
054        /*------------*\
055    ====** Attributes **=======================================================
056        \*------------*/
057    /**
058     *  Returns the notifier types (in dot notation).
059     *
060     *  @return The notifier types; the default is an empty array.
061     */
062    String [] notifierTypes() default {};
063
064    /**
065     *  Returns the class of the notification implementation.
066     *
067     *  @return The class of the notification implementation.
068     */
069    Class<?> notificationClass();
070
071    /**
072     *  Returns the description of the notification.
073     *
074     *  @return The description of the notification.
075     */
076    String description();
077}
078//  @interface MBeanNotification
079
080/*
081 *  End of File
082 */