src/jdk.jfr/share/classes/jdk/jfr/Period.java
author egahlin
Tue, 15 May 2018 20:24:34 +0200
changeset 50113 caf115bb98ad
permissions -rw-r--r--
8199712: Flight Recorder Reviewed-by: coleenp, ihse, erikj, dsamersoff, mseledtsov, egahlin, mgronlun Contributed-by: erik.gahlin@oracle.com, markus.gronlund@oracle.com
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
 * Event annotation, specifies the default setting value for a periodic event.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
 * @since 9
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
@MetadataDefinition
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
@Retention(RetentionPolicy.RUNTIME)
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
@Inherited
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
@Target(ElementType.TYPE)
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
public @interface Period {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
     * Settings name {@code "period"} for configuring periodic events
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
    public final static String NAME = "period";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
     * Returns the default setting value for a periodic setting.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
     * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
     * String representation of a positive {@code Long} value followed by an empty
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
     * space and one of the following units:<br>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
     * <br>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
     * {@code "ns"} (nanoseconds)<br>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
     * {@code "us"} (microseconds)<br>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
     * {@code "ms"} (milliseconds)<br>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
     * {@code "s"} (seconds)<br>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
     * {@code "m"} (minutes)<br>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
     * {@code "h"} (hours)<br>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
     * {@code "d"} (days)<br>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
     * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
     * Example values: {@code "0 ns"}, {@code "10 ms"}, and {@code "1 s"}.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
     * <p>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
     * A period may also be <code>"everyChunk"</code> to specify that it occurs at
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
     * least once for every recording file. The number of events that are emitted
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
     * depends on how many times the file rotations occur when data is recorded.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
     * @return the default setting value, not {@code null}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
    String value() default "everyChunk";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
}