Package biz.gabrys.maven.plugin.util.timer

Class SystemTimer

java.lang.Object

biz.gabrys.maven.plugin.util.timer.SystemTimer

All Implemented Interfaces:

Timer

public class SystemTimer
extends Object
implements Timer

Default implementation of the Timer which based on the System.currentTimeMillis() method.

Example:

 public class ExampleMojo extends AbstractMojo {

     public void execute() {
         Timer timer = SystemTimer.getStartedTimer();

         // logic
         ...

         getLog().info("Finished in " + timer.stop());
     }
 }
 

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
SystemTimer()	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
static SystemTimer	getStartedTimer()	Returns a new started timer.
TimeSpan	getTime()	Returns a current counted execution time.
void	start()	Starts counting execution time.
TimeSpan	stop()	Stops counting execution time.

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemTimer

public SystemTimer()

Constructs a new instance.

Since:

1.0

Method Detail

start

public void start()

Description copied from interface: Timer

Starts counting execution time.

Specified by:

start in interface Timer

stop

public TimeSpan stop()

Description copied from interface: Timer

Stops counting execution time.

Specified by:

stop in interface Timer

Returns:

the counted execution time.

getTime

public TimeSpan getTime()

Returns a current counted execution time. The current counted time span is equal to:

• null when timer has not been started
• current time - start time when timer has been started and has not been stopped
• counted time during stop when timer has been stopped

Specified by:

getTime in interface Timer

Returns:

the current counted execution time.

Since:

2.0.0

getStartedTimer

public static SystemTimer getStartedTimer()

Returns a new started timer.

Returns:

the new timer.

Since:

1.0

See Also:

start()