Enum Class RecordingState

java.lang.Object

java.lang.Enum<RecordingState>

jdk.jfr.RecordingState

All Implemented Interfaces:: Serializable, Comparable<RecordingState>, Constable

public enum RecordingState extends Enum<RecordingState>

Indicates a state in the life cycle of a recording.

Since:: 9

Nested Class Summary

Nested classes/interfaces declared in class Enum

Enum.EnumDesc<E>

Modifier and Type	Class	Description
`static final class`	`Enum.EnumDesc<E extends Enum<E>>`	A nominal descriptor for an `enum` constant.

Enum Constant Summary

Enum Constant	Description
`CLOSED`	The recording is closed and all resources that are associated with the recording are released.
`DELAYED`	The recording is scheduled to start with a start time in the future.
`NEW`	The initial state when a `Recording` is created.
`RUNNING`	The recording is recording data and an invocation of the `Recording.stop()` method will transition the recording to the `STOPPED` state.
`STOPPED`	The recording is stopped and is holding recorded data that can be dumped to disk.

Method Summary

Modifier and Type	Method	Description
`static RecordingState`	`valueOf(String name)`	Returns the enum constant of this class with the specified name.
`static RecordingState[]`	`values()`	Returns an array containing the constants of this enum class, in the order they are declared.

Methods declared in class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Modifier and Type	Method	Description
`protected final Object`	`clone()`	Throws CloneNotSupportedException.
`final int`	`compareTo(RecordingState o)`	Compares this enum with the specified object for order.
`final Optional<Enum.EnumDesc<RecordingState>>`	`describeConstable()`	Returns an enum descriptor `EnumDesc` for this instance, if one can be constructed, or an empty `Optional` if one cannot be.
`final boolean`	`equals(Object other)`	Returns true if the specified object is equal to this enum constant.
`protected final void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization has been deprecated for removal.
`final Class<RecordingState>`	`getDeclaringClass()`	Returns the Class object corresponding to this enum constant's enum type.
`final int`	`hashCode()`	Returns a hash code for this enum constant.
`final String`	`name()`	Returns the name of this enum constant, exactly as declared in its enum declaration.
`final int`	`ordinal()`	Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
`String`	`toString()`	Returns the name of this enum constant, as contained in the declaration.
`static <T extends Enum<T>> T`	`valueOf(Class<T> enumClass, String name)`	Returns the enum constant of the specified enum class with the specified name.

Methods declared in class Object

getClass, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Enum Constant Details

NEW

public static final RecordingState NEW

The initial state when a Recording is created.

DELAYED

public static final RecordingState DELAYED

The recording is scheduled to start with a start time in the future.

An invocation of the Recording.start() method will transition the recording to the RUNNING state.

RUNNING

public static final RecordingState RUNNING

The recording is recording data and an invocation of the Recording.stop() method will transition the recording to the STOPPED state.

STOPPED

public static final RecordingState STOPPED

The recording is stopped and is holding recorded data that can be dumped to disk.

An invocation of the Recording.close() method will release the data and transition the recording to the CLOSED state.

CLOSED

public static final RecordingState CLOSED

The recording is closed and all resources that are associated with the recording are released.

Nothing that can be done with a recording from this point, and it's no longer retrievable from the FlightRecorder.getRecordings() method.

Method Details

values

public static RecordingState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:: an array containing the constants of this enum class, in the order they are declared

valueOf

public static RecordingState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:: name - the name of the enum constant to be returned.
Returns:: the enum constant with the specified name
Throws:: IllegalArgumentException - if this enum class has no constant with the specified name; NullPointerException - if the argument is null

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.