/*
 * Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package jdk.jfr.internal;

import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import jdk.jfr.MetadataDefinition;

Event annotation, determines the cutoff above which an event should not be recorded, i.e. "20 ms". This settings is only supported for JVM events. 
Since:
9/**
 * Event annotation, determines the cutoff above which an event should not be
 * recorded, i.e. {@code "20 ms"}.
 *
 * This settings is only supported for JVM events.
 *
 * @since 9
 */
@MetadataDefinition
@Target({ ElementType.TYPE })
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface Cutoff {
    
Settings name "cutoff" for configuring event cutoffs. /**
     * Settings name {@code "cutoff"} for configuring event cutoffs.
     */
    public final static String NAME = "cutoff";
    public final static String INFINITY = "infinity";

    
Cutoff, for example "20 ms". 
 String representation of a positive Long value followed by an empty space and one of the following units


 "ns" (nanoseconds)
 "us" (microseconds)
 "ms" (milliseconds)
 "s" (seconds)
 "m" (minutes)
 "h" (hours)
 "d" (days)

 Example values, "0 ns", "10 ms" and "1 s". If the events has an infinite timespan, the text "infinity" should be used. 
Returns:
the threshold, default "0 ns" not null/**
     * Cutoff, for example {@code "20 ms"}.
     * <p>
     * String representation of a positive {@code Long} value followed by an empty
     * space and one of the following units<br>
     * <br>
     * {@code "ns"} (nanoseconds)<br>
     * {@code "us"} (microseconds)<br>
     * {@code "ms"} (milliseconds)<br>
     * {@code "s"} (seconds)<br>
     * {@code "m"} (minutes)<br>
     * {@code "h"} (hours)<br>
     * {@code "d"} (days)<br>
     * <p>
     * Example values, {@code "0 ns"}, {@code "10 ms"} and {@code "1 s"}. If the
     * events has an infinite timespan, the text {@code "infinity"} should be used.
     *
     * @return the threshold, default {@code "0 ns"} not {@code null}
     */
    String value() default "infinity";
}