Package org.openjdk.jmc.flightrecorder.writer.api

Class Recordings

java.lang.Object

org.openjdk.jmc.flightrecorder.writer.api.Recordings

public final class Recordings
extends Object

A factory class to create new Recording instances

Constructor Summary

Constructors

Constructor	Description
Recordings()

Method Summary

Modifier and Type	Method	Description
static Recording	newRecording(File path)	Create a new recording that will be automatically stored in the given file.
static Recording	newRecording(File path, Consumer<RecordingSettingsBuilder> settingsCallback)	Create a new recording that will be automatically stored in the given file.
static Recording	newRecording(OutputStream recordingStream)	Create a new recording that will be automatically stored in the given stream.
static Recording	newRecording(OutputStream recordingStream, Consumer<RecordingSettingsBuilder> settingsCallback)	Create a new recording that will be automatically stored in the given stream.
static Recording	newRecording(String path)	Create a new recording that will be automatically stored in the given file.
static Recording	newRecording(String path, Consumer<RecordingSettingsBuilder> settingsCallback)	Create a new recording that will be automatically stored in the given file.
static Recording	newRecording(Path path)	Create a new recording that will be automatically stored in the given path.
static Recording	newRecording(Path path, Consumer<RecordingSettingsBuilder> settingsCallback)	Create a new recording that will be automatically stored in the given path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Recordings

public Recordings()

Method Detail

newRecording

public static Recording newRecording(String path)
                              throws IOException

Create a new recording that will be automatically stored in the given file. The recording start timestamp is set to the current time and the recording will automatically initialize JDK types.

Parameters:

path - the path to the recording file

Returns:

a new Recording instance

Throws:

IOException

newRecording

public static Recording newRecording(String path,
                                     Consumer<RecordingSettingsBuilder> settingsCallback)
                              throws IOException

Create a new recording that will be automatically stored in the given file.

Parameters:

path - the path to the recording file

settingsCallback - settings callback

Returns:

a new Recording instance

Throws:

IOException

newRecording

public static Recording newRecording(Path path)
                              throws IOException

Create a new recording that will be automatically stored in the given path. The recording start timestamp is set to the current time and the recording will automatically initialize JDK types.

Parameters:

path - the path to the recording file

Returns:

a new Recording instance

Throws:

IOException

newRecording

public static Recording newRecording(Path path,
                                     Consumer<RecordingSettingsBuilder> settingsCallback)
                              throws IOException

Create a new recording that will be automatically stored in the given path.

Parameters:

path - the path to the recording file

settingsCallback - settings callback

Returns:

a new Recording instance

Throws:

IOException

newRecording

public static Recording newRecording(File path)
                              throws IOException

Create a new recording that will be automatically stored in the given file. The recording start timestamp is set to the current time and the recording will automatically initialize JDK types.

Parameters:

path - the path to the recording file

Returns:

a new Recording instance

Throws:

IOException

newRecording

public static Recording newRecording(File path,
                                     Consumer<RecordingSettingsBuilder> settingsCallback)
                              throws IOException

Create a new recording that will be automatically stored in the given file.

Parameters:

path - the path to the recording file

settingsCallback - settings callback

Returns:

a new Recording instance

Throws:

IOException

newRecording

public static Recording newRecording(OutputStream recordingStream)

Create a new recording that will be automatically stored in the given stream. The recording start timestamp is set to the current time and the recording will automatically initialize JDK types.

Parameters:

recordingStream - recording output stream

Returns:

a new Recording instance

newRecording

public static Recording newRecording(OutputStream recordingStream,
                                     Consumer<RecordingSettingsBuilder> settingsCallback)

Create a new recording that will be automatically stored in the given stream.

Parameters:

recordingStream - recording output stream

settingsCallback - settings callback

Returns:

a new Recording instance