Package com.jprofiler.api.controller
Class ProbeRecordingOptions
- java.lang.Object
-
- com.jprofiler.api.controller.ProbeRecordingOptions
-
public class ProbeRecordingOptions extends java.lang.ObjectSpecial probe recording options for callingController.startProbeRecording(String, ProbeRecordingOptions). The default values after constructing an instance of this class are all set tofalse.
-
-
Field Summary
Fields Modifier and Type Field Description static ProbeRecordingOptionsEVENTSSame asNONE, only withevents(true).static ProbeRecordingOptionsNONENo special recordings are active.
-
Constructor Summary
Constructors Constructor Description ProbeRecordingOptions()Create a new instance with the default options described above.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProbeRecordingOptionsconnectionLeaks(boolean connectionLeaks)Determines whether connection leaks should be recorded for the JDBC probe.ProbeRecordingOptionsevents(boolean events)Determines whether single events should be recorded for the "Events" view of the probe.ProbeRecordingOptionsfreeze()Make these recording options unmodifiable.booleanisConnectionLeaks()Returns if connection leaks are recorded for the JDBC probe.booleanisEvents()Returns if single events are recorded for the "Events" view of the probe.
-
-
-
Field Detail
-
NONE
public static final ProbeRecordingOptions NONE
No special recordings are active. This is the same asconstructinga new object without calling any further methods.
-
EVENTS
public static final ProbeRecordingOptions EVENTS
Same asNONE, only withevents(true).
-
-
Method Detail
-
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 isfalse.- 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 isfalse.- 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 aUnsupportedOperationException.- Returns:
- this instance
-
-