src/jdk.jfr/share/classes/jdk/jfr/RecordingState.java
changeset 50113 caf115bb98ad
equal deleted inserted replaced
50112:7a2a740815b7 50113:caf115bb98ad
       
     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 /**
       
    29  * Indicates a state in the life cycle of a recording.
       
    30  *
       
    31  * @since 9
       
    32  */
       
    33 public enum RecordingState {
       
    34 
       
    35     /**
       
    36      * The initial state when a {@code Recording} is created.
       
    37      */
       
    38     NEW,
       
    39 
       
    40     /**
       
    41      * The recording is scheduled to start with a start time in the future.
       
    42      * <p>
       
    43      * An invocation of the {@link Recording#start()} method will transition the
       
    44      * recording to the {@code RUNNING} state.
       
    45      */
       
    46     DELAYED,
       
    47 
       
    48     /**
       
    49      * The recording is recording data and an invocation of the {@link Recording#stop()}
       
    50      * method will transition the recording to the {@code STOPPED} state.
       
    51      */
       
    52     RUNNING,
       
    53 
       
    54     /**
       
    55      * The recording is stopped and is holding recorded data that can be dumped to
       
    56      * disk.
       
    57      * <p>
       
    58      * An invocation of the {@link Recording#close()} method will release the
       
    59      * data and transition the recording to the {@code CLOSED} state.
       
    60      */
       
    61     STOPPED,
       
    62 
       
    63     /**
       
    64      * The recording is closed and all resources that are associated with the
       
    65      * recording are released.
       
    66      * <p>
       
    67      * Nothing that can be done with a recording from this point, and it's
       
    68      * no longer retrievable from the {@code FlightRrecorder.getRecordings()} method.
       
    69      */
       
    70     CLOSED;
       
    71 }