1 /*
   2  * Copyright (c) 2016, 2019, 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  * Annotation that signifies that an element is experimental and may change
  36  * without notice.
  37  * <p>
  38  * Clients that visualize Flight Recorder events should <em>not</em> show the
  39  * events or fields annotated with the {@code Experimental} annotation by
  40  * default. This annotation allows event producers the freedom to try out new
  41  * events without committing to them.
  42  * <p>
  43  * Clients may provide a check box (for example, in a preference page) where a
  44  * user can opt-in to display experimental data. If the user decide to do so,
  45  * the user interface should mark experimental events or fields so users can
  46  * distinguish them from non-experimental events.
  47  * <p>
  48  * This annotation is inherited.
  49  *
  50  * @since 9
  51  */
  52 @MetadataDefinition
  53 @Label("Experimental")
  54 @Description("Element is not to be shown to a user by default")
  55 @Inherited
  56 @Retention(RetentionPolicy.RUNTIME)
  57 @Target({ ElementType.FIELD, ElementType.TYPE })
  58 public @interface Experimental {
  59 }