Package com.jprofiler.api.controller

Class ProbeRecordingOptions

java.lang.Object

com.jprofiler.api.controller.ProbeRecordingOptions

public class ProbeRecordingOptions
extends Object

Special probe recording options for calling Controller.startProbeRecording(String, ProbeRecordingOptions). The default values after constructing an instance of this class are all set to false.

Field Summary

Fields

Modifier and Type	Field	Description
static final ProbeRecordingOptions	EVENTS	Same as NONE, only with events(true).
static final ProbeRecordingOptions	NONE	No special recordings are active.

Constructor Summary

Constructors

Constructor	Description
ProbeRecordingOptions()	Create a new instance with the default options described above.

Method Summary

Modifier and Type	Method	Description
ProbeRecordingOptions	connectionLeaks(boolean connectionLeaks)	Determines whether connection leaks should be recorded for the JDBC probe.
ProbeRecordingOptions	events(boolean events)	Determines whether single events should be recorded for the "Events" view of the probe.
ProbeRecordingOptions	freeze()	Make these recording options unmodifiable.
boolean	isConnectionLeaks()	Returns if connection leaks are recorded for the JDBC probe.
boolean	isEvents()	Returns if single events are recorded for the "Events" view of the probe.

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static final ProbeRecordingOptions NONE

No special recordings are active. This is the same as constructing a new object without calling any further methods.

EVENTS

public static final ProbeRecordingOptions EVENTS

Same as NONE, only with events(true).

Constructor Details

ProbeRecordingOptions

public ProbeRecordingOptions()

Create a new instance with the default options described above.

Method Details

events

public ProbeRecordingOptions events(boolean events)

Determines whether single events should be recorded for the "Events" view of the probe. This setting has no effect when used with a probe that does not have an event view. The default is false.

Parameters:

events - the new value

Returns:

this instance

connectionLeaks

public ProbeRecordingOptions connectionLeaks(boolean connectionLeaks)

Determines whether connection leaks should be recorded for the JDBC probe. This setting has no effect when used with other probes. The default is false.

Parameters:

connectionLeaks - the new value

Returns:

this instance

isEvents

public boolean isEvents()

Returns if single events are recorded for the "Events" view of the probe.

Returns:

the value

isConnectionLeaks

public boolean isConnectionLeaks()

Returns if connection leaks are recorded for the JDBC probe.

Returns:

the value

freeze

public ProbeRecordingOptions freeze()

Make these recording options unmodifiable. Further modification attempts will result in a UnsupportedOperationException.

Returns:

this instance