Package org.apache.wayang.commons.util.profiledb.instrumentation

Class StopWatch

java.lang.Object

org.apache.wayang.commons.util.profiledb.instrumentation.StopWatch

public class StopWatch
extends Object

Utility to create TimeMeasurements for an Experiment.

Constructor Summary

Constructors

Constructor	Description
StopWatch(Experiment experiment)	Creates a new instance for the given Experiment.

Method Summary

Modifier and Type	Method	Description
Experiment	getExperiment()	Get the Experiment managed by this instance.
TimeMeasurement	getOrCreateRound(String id, String... furtherIds)	Retrieves a TimeMeasurement by its ID from rounds.
TimeMeasurement	start(String id, String... furtherIds)	Starts a TimeMeasurement.
void	stop(String id, String... furtherIds)	Stops a TimeMeasurement (if it exists).
void	stopAll()	Stops all TimeMeasurements known to this instance.
String	toPrettyString()	Formats the TimeMeasurements to something easily readable.
String	toPrettyString(String indent, String bullet)	Formats the TimeMeasurements to something easily readable.

Methods inherited from class java.lang.Object

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

Constructor Details

StopWatch

public StopWatch(Experiment experiment)

Creates a new instance for the given Experiment.

Parameters:

experiment - that should be instrumented

Method Details

getOrCreateRound

public TimeMeasurement getOrCreateRound(String id,
 String... furtherIds)

Retrieves a TimeMeasurement by its ID from rounds. If it does not exist, it will be created and also registered with the experiment.

Parameters:

id - the ID of the TimeMeasurement

furtherIds - IDs of further nested TimeMeasurements

Returns:

the TimeMeasurement

start

public TimeMeasurement start(String id,
 String... furtherIds)

Starts a TimeMeasurement. Any required parent TimeMeasurement will be started if necessary.

Parameters:

id - ID of the root TimeMeasurement

furtherIds - IDs of further nested TimeMeasurements

Returns:

the (potentially new) TimeMeasurement

stop

public void stop(String id,
 String... furtherIds)

Stops a TimeMeasurement (if it exists).

Parameters:

id - ID of the root TimeMeasurement

furtherIds - IDs of further nested TimeMeasurements

toPrettyString

public String toPrettyString()

Formats the TimeMeasurements to something easily readable.

Returns:

the "pretty" String

toPrettyString

public String toPrettyString(String indent,
 String bullet)

Formats the TimeMeasurements to something easily readable.

Parameters:

indent - indent to be used when formatting sub-TimeMeasurements

bullet - bullet point character

Returns:

the "pretty" String

stopAll

public void stopAll()

Stops all TimeMeasurements known to this instance.

getExperiment

public Experiment getExperiment()

Get the Experiment managed by this instance.

Returns:

the Experiment