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.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 class and all of its subclasses as
034 *  manageable by an assigned instance of
035 *  {@link JMXSupport}.
036 *
037 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
038 *  @version $Id: ManagedObject.java 995 2022-01-23 01:09:35Z tquadrat $
039 *  @since 0.0.1
040 */
041@ClassVersion( sourceVersion = "$Id: ManagedObject.java 995 2022-01-23 01:09:35Z tquadrat $" )
042@API( status = STABLE, since = "0.0.1" )
043@Documented
044@Retention( RetentionPolicy.RUNTIME )
045@Target( ElementType.TYPE )
046@Inherited
047public @interface ManagedObject
048{
049        /*------------*\
050    ====** Attributes **=======================================================
051        \*------------*/
052    /**
053     *  The description of the instrumented object.
054     *
055     *  @return The description.
056     */
057    String description();
058
059    /**
060     *  The instrumented object will send notifications.
061     *
062     *  @return {@code true} if the instrumented object will send
063     *      notifications, {@code false} (the default) otherwise.
064     */
065    boolean useNotifications() default false;
066}
067//  @interface ManagedObject
068
069/*
070 *  End of File
071 */