Module datarush.commons

Package com.pervasive.datarush.monitoring

Class AccumulatedTimer

java.lang.Object

com.pervasive.datarush.monitoring.AccumulatedTimer

All Implemented Interfaces:

AccumulatedTimerSupplier, StatisticSupplier

public final class AccumulatedTimer
extends Object
implements AccumulatedTimerSupplier

Basic mutable implementation of AccumulatedTimerSupplier.

Constructor Summary

Constructors

Constructor	Description
AccumulatedTimer()	Creates a new timer in the StatisticState.UNAVAILABLE state.

Method Summary

Modifier and Type	Method	Description
long	getAccumulatedTimeMillis()	The accumulated time so far.
StatisticState	getState()	Returns the current state of the supplier.
void	pause()	Pauses the timer; time will not accumulate until the next call to start().
AccumulatedTimerSupplier	snapshot()	Creates a snapshot of this timer.
void	start()	Starts the timer; time will begin to accumulate
void	stop()	Stops the timer.

Methods inherited from class java.lang.Object

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

Constructor Details

AccumulatedTimer

public AccumulatedTimer()

Creates a new timer in the StatisticState.UNAVAILABLE state.

Method Details

getState

public StatisticState getState()

Description copied from interface: StatisticSupplier

Returns the current state of the supplier.

Specified by:

getState in interface StatisticSupplier

Returns:

the state of the supplier

start

public void start()

Starts the timer; time will begin to accumulate

Throws:

IllegalStateException - if the timer is already started or has finished

pause

public void pause()

Pauses the timer; time will not accumulate until the next call to start().

stop

public void stop()

Stops the timer. This method can be called while in any state and thus is safe to call within a finally block.

getAccumulatedTimeMillis

public long getAccumulatedTimeMillis()

Description copied from interface: AccumulatedTimerSupplier

The accumulated time so far. For aggregations, this is the sum over all partitions of the to be the sum over all partitions of the partition's AccumulatedTimerSupplier.getAccumulatedTimeMillis(). This value is undefined if the timer is StatisticState.UNAVAILABLE.

Specified by:

getAccumulatedTimeMillis in interface AccumulatedTimerSupplier

Returns:

the accumulated time in milliseconds.

snapshot

public AccumulatedTimerSupplier snapshot()

Description copied from interface: AccumulatedTimerSupplier

Creates a snapshot of this timer. If the timer is in the StatisticState.ACTIVE

Specified by:

snapshot in interface AccumulatedTimerSupplier

Specified by:

snapshot in interface StatisticSupplier

Returns:

a snapshot of this statistic.