com.google.cloud.tools.jib.event.events

Class TimerEvent

java.lang.Object

com.google.cloud.tools.jib.event.events.TimerEvent

All Implemented Interfaces:

JibEvent

public class TimerEvent
extends Object
implements JibEvent

Timer event for timing various part of Jib's execution.

Timer events follow a specific TimerEvent.Timer through a TimerEvent.State.START, TimerEvent.State.LAP, and TimerEvent.State.FINISHED states. The duration indicates the duration since the last TimerEvent dispatched for the TimerEvent.Timer.

Timers can also define a hierarchy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimerEvent.State The state of the timing.
static interface	TimerEvent.Timer Defines a timer hierarchy.

Constructor Summary

Constructors

Constructor and Description
TimerEvent(TimerEvent.State state, TimerEvent.Timer timer, Duration duration, Duration elapsed, String description) Creates a new TimerEvent.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets the description associated with this event.
Duration	getDuration() Gets the duration since the last TimerEvent for this timer.
Duration	getElapsed() Gets the total elapsed duration since this timer was created.
TimerEvent.State	getState() Gets the state of the timer.
TimerEvent.Timer	getTimer() Gets the timer this event is for.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimerEvent

public TimerEvent(TimerEvent.State state,
                  TimerEvent.Timer timer,
                  Duration duration,
                  Duration elapsed,
                  String description)

Creates a new TimerEvent. For internal use only.

Parameters:

state - the state of the TimerEvent.Timer

timer - the TimerEvent.Timer

duration - the lap duration

elapsed - the total elapsed time since the timer was created

description - the description of this event

Method Detail

getState

public TimerEvent.State getState()

Gets the state of the timer.

Returns:

the state of the timer

See Also:

TimerEvent.State

getTimer

public TimerEvent.Timer getTimer()

Gets the timer this event is for.

Returns:

the timer

getDuration

public Duration getDuration()

Gets the duration since the last TimerEvent for this timer.

Returns:

the duration since the last TimerEvent for this timer.

getElapsed

public Duration getElapsed()

Gets the total elapsed duration since this timer was created.

Returns:

the duration since this timer was created

getDescription

public String getDescription()

Gets the description associated with this event.

Returns:

the description