io.github.wysohn.triggerreactor.tools.timings

Class Timings.Timing

java.lang.Object

io.github.wysohn.triggerreactor.tools.timings.Timings.Timing

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

Timings.LimboTiming

Enclosing class:

Timings

public static class Timings.Timing
extends Object
implements AutoCloseable

Method Summary

Modifier and Type	Method and Description
double	avg()
Timings.Timing	begin() Record current system timestamp and return this Timing instance.
Timings.Timing	begin(boolean mainThread) Record current system timestamp and return this Timing instance.
void	close()
String	getDisplayName()
Timings.Timing	getTiming(String name) Get Timing starting from 'this' Timing as root.
boolean	isLeafNode()
void	setDisplayName(String displayName)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getDisplayName

public String getDisplayName()

setDisplayName

public void setDisplayName(String displayName)

isLeafNode

public boolean isLeafNode()

getTiming

public Timings.Timing getTiming(String name)

Get Timing starting from 'this' Timing as root.

For example, if 'this' Timing is "Some.Thing," any Timing made by this method will always start with "Some.Thing".

Parameters:

name - the fully qualified name to extend from 'this' Timing.

Returns:

the child timing. 'this' Timing if name is null.

begin

public Timings.Timing begin(boolean mainThread)

Record current system timestamp and return this Timing instance. As Timing is AutoCloseable, you can use the try resources which is newly introduced in Java 8. The execution time will be logged automatically by the close() method.

try(Timing t = Timings.getTiming("my.timing")){
Thread.sleep(10L);
}

Parameters:

mainThread - mark it to indicate that the task ran by the main thread.

Returns:

this instance

begin

public Timings.Timing begin()

Record current system timestamp and return this Timing instance. As Timing is AutoCloseable, you can use the try resources which is newly introduced in Java 8. The execution time will be logged automatically by the close() method.

try(Timing t = Timings.getTiming("my.timing")){
Thread.sleep(10L);
}

Returns:

this instance

avg

public double avg()

close

public void close()

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object