Package org.apache.wayang.commons.util.profiledb.model.measurement

Class TimeMeasurement

java.lang.Object

org.apache.wayang.commons.util.profiledb.model.Measurement

org.apache.wayang.commons.util.profiledb.model.measurement.TimeMeasurement

public class TimeMeasurement
extends Measurement

A Measurement that captures a certain amount of time in milliseconds. Instances can be nested within each other.

Besides storing those data, it also provides utility functionality to obtain measurements.

Constructor Summary

Constructors

Constructor	Description
TimeMeasurement(java.lang.String id)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addRounds(TimeMeasurement round)
static java.lang.String	formatDuration(long millis)	Formats the given milliseconds as h:MM:ss.mmm.
long	getMillis()
TimeMeasurement	getOrCreateRound(java.lang.String id)	Retrieves an existing TimeMeasurement from rounds with the given id or creates and stores a new one.
java.util.Collection<TimeMeasurement>	getRounds()
void	setMillis(long millis)
void	start()	Start measuring time for this instance.
TimeMeasurement	start(java.lang.String... identifiers)	Start a (potentially new) sub-TimeMeasurement.
void	stop()	Stop a measurement that has been started via start() or derivatives.
void	stop(java.lang.String... identfiers)	Stop a measurement that has been started via start(String...) or related.
java.lang.String	toString()

Methods inherited from class org.apache.wayang.commons.util.profiledb.model.Measurement

equals, getId, getType, getTypeName, hashCode, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeMeasurement

public TimeMeasurement(java.lang.String id)

Creates a new instance.

Parameters:

id - the ID of the new instance

Method Detail

start

public void start()

Start measuring time for this instance.

start

public TimeMeasurement start(java.lang.String... identifiers)

Start a (potentially new) sub-TimeMeasurement.

Parameters:

identifiers - identifies the target TimeMeasurement as a path of IDs

Returns:

the started instance

getOrCreateRound

public TimeMeasurement getOrCreateRound(java.lang.String id)

Retrieves an existing TimeMeasurement from rounds with the given id or creates and stores a new one.

Parameters:

id - the ID of the TimeMeasurement

Returns:

the TimeMeasurement

stop

public void stop()

Stop a measurement that has been started via start() or derivatives.

stop

public void stop(java.lang.String... identfiers)

Stop a measurement that has been started via start(String...) or related.

Parameters:

identfiers - identify the target TimeMeasurement as a path of IDs

getMillis

public long getMillis()

setMillis

public void setMillis(long millis)

getRounds

public java.util.Collection<TimeMeasurement> getRounds()

addRounds

public void addRounds(TimeMeasurement round)

formatDuration

public static java.lang.String formatDuration(long millis)

Formats the given milliseconds as h:MM:ss.mmm.

Parameters:

millis - the milliseconds to format

Returns:

the formatted milliseconds

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object