src/jdk.jfr/share/classes/jdk/jfr/Experimental.java
author pmuthuswamy
Tue, 30 Apr 2019 11:58:30 +0530
changeset 54648 89f2043ee67a
parent 50113 caf115bb98ad
permissions -rw-r--r--
8221991: Improve the HTML for the inheritance tree for a type Reviewed-by: hannesw
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     1
/*
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     2
 * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     4
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    10
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    15
 * accompanied this code).
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    16
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    20
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    23
 * questions.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    24
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    25
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    26
package jdk.jfr;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
import java.lang.annotation.ElementType;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
import java.lang.annotation.Inherited;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
import java.lang.annotation.Retention;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
import java.lang.annotation.RetentionPolicy;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
import java.lang.annotation.Target;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
/**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
 * Annotation that specifies that an element is experimental and may change
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
 * without notice.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
 * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
 * Clients that visualize Flight Recorder events should <em>not</em> show the
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
 * events or fields annotated with the {@code Experimental} annotation by
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
 * default. This annotation allows event producers the freedom to try out new
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
 * events without committing to them.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
 * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
 * Clients may provide a check box (for example, in a preference page) where a
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
 * user can opt-in to display experimental data. If the user decide to do so,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
 * the user interface should mark experimental events or fields so users can
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
 * distinguish them from non-experimental events.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
 * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
 * This annotation is inherited.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
 * @since 9
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
@MetadataDefinition
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
@Label("Experimental")
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
@Description("Element is not to be shown to a user by default")
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
@Inherited
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
@Retention(RetentionPolicy.RUNTIME)
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
@Target({ ElementType.FIELD, ElementType.TYPE })
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
public @interface Experimental {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
}