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

Class RecordingSettings

java.lang.Object

org.openjdk.jmc.flightrecorder.writer.api.RecordingSettings

public final class RecordingSettings
extends Object

A settings data-class for a Recording instance

Constructor Summary

Constructors

Constructor	Description
RecordingSettings()	Recording will use current time as its start timestamp and will initialize Types.JDK types.
RecordingSettings(boolean initializeJDKTypes)	Recording will use current time as its start timestamp
RecordingSettings(long startTimestamp)	Recording will initialize Types.JDK types.
RecordingSettings(long startTimestamp, boolean initializeJDKTypes)
RecordingSettings(long startTimestamp, long startTicks, long duration, boolean initializeJDKTypes)

Method Summary

Modifier and Type	Method	Description
long	getDuration()
long	getStartTicks()
long	getStartTimestamp()
boolean	shouldInitializeJDKTypes()

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordingSettings

public RecordingSettings(long startTimestamp,
                         long startTicks,
                         long duration,
                         boolean initializeJDKTypes)

Parameters:

startTimestamp - the recording start timestamp in epoch nanoseconds (nanoseconds since 1970-01-01) or -1 to use System.currentTimeMillis() * 1_000_000

startTicks - the recording start timestamp in ticks or -1 to use System.nanoTime()

duration - the recording duration in ticks or -1 to use the current System.nanoTime() to compute the diff from startTicks

initializeJDKTypes - should the Types.JDK types be initialized

RecordingSettings

public RecordingSettings(long startTimestamp,
                         boolean initializeJDKTypes)

Parameters:

startTimestamp - the recording start timestamp in epoch nanoseconds (nanoseconds since 1970-01-01)

initializeJDKTypes - should the Types.JDK types be initialized

RecordingSettings

public RecordingSettings(boolean initializeJDKTypes)

Recording will use current time as its start timestamp

Parameters:

initializeJDKTypes - should the Types.JDK types be initialized

RecordingSettings

public RecordingSettings(long startTimestamp)

Recording will initialize Types.JDK types.

Parameters:

startTimestamp - the recording start timestamp in epoch nanoseconds (nanoseconds since 1970-01-01)

RecordingSettings

public RecordingSettings()

Recording will use current time as its start timestamp and will initialize Types.JDK types.

Method Detail

getStartTimestamp

public long getStartTimestamp()

Returns:

recording timestamp in epoch nanoseconds (nanoseconds since 1970-01-01)

getStartTicks

public long getStartTicks()

Returns:

recording timestamp in ticks or -1 to use the current value of System.nanoTime()

getDuration

public long getDuration()

Returns:

recording duration in ticks or -1 to derive it from System.nanoTime()

shouldInitializeJDKTypes

public boolean shouldInitializeJDKTypes()

Returns:

true if Types.JDK types are to be initialized