1 /*
2  * Copyright (c) 2016, 2018, Oracle and/or its affiliates. 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.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package jdk.jfr;
27 
28 import java.lang.annotation.ElementType;
29 import java.lang.annotation.Inherited;
30 import java.lang.annotation.Retention;
31 import java.lang.annotation.RetentionPolicy;
32 import java.lang.annotation.Target;
33 
34 /**
35  * Event annotation, for programmatic event registration.
36  * <p>
37  * Events are automatically registered when they are first used. This annotation
38  * can be used to override that registration. To register
39  * events programmatically, use {@link FlightRecorder#register(Class)}.
40  *
41  * @since 9
42  */
43 @Target({ ElementType.TYPE })
44 @Inherited
45 @Retention(RetentionPolicy.RUNTIME)
46 public @interface Registered {
47     /**
48      * Returns {@code true} if the event is to be registered when the event class is
49      * first used, {@code false} otherwise.
50      *
51      * @return {@code true} if the event is to be registered when the event class is
52      *         first used, {@code false} otherwise.
53      */
value()54     public boolean value() default true;
55 }
56