Module datarush.commons

Package com.pervasive.datarush.monitoring

Class AccumulatedTimerSnapshot

java.lang.Object

com.pervasive.datarush.monitoring.AccumulatedTimerSnapshot

All Implemented Interfaces:

AccumulatedTimerSupplier, StatisticSupplier, Serializable

public final class AccumulatedTimerSnapshot
extends Object
implements AccumulatedTimerSupplier, Serializable

A snapshot that reflects a point-in-time of a IntervalTimerSupplier.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static AccumulatedTimerSnapshot	UNAVAILABLE	Constant that corresponds to a snapshot of a counter in the StatisticState.UNAVAILABLE state.

Constructor Summary

Constructors

Constructor	Description
AccumulatedTimerSnapshot(AccumulatedTimerSupplier source)	Create a snapshot of the given timer.
AccumulatedTimerSnapshot(StatisticState state, long accumulatedTimeMillis)	Create a snapshot with the specified values

Method Summary

Modifier and Type	Method	Description
long	getAccumulatedTimeMillis()	The accumulated time so far.
StatisticState	getState()	Returns the current state of the supplier.
AccumulatedTimerSnapshot	snapshot()	Creates a snapshot of this timer.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNAVAILABLE

public static final AccumulatedTimerSnapshot UNAVAILABLE

Constant that corresponds to a snapshot of a counter in the StatisticState.UNAVAILABLE state.

Constructor Detail

AccumulatedTimerSnapshot

public AccumulatedTimerSnapshot(AccumulatedTimerSupplier source)

Create a snapshot of the given timer.

Parameters:

source - the timer

AccumulatedTimerSnapshot

public AccumulatedTimerSnapshot(StatisticState state,
                                long accumulatedTimeMillis)

Create a snapshot with the specified values

Parameters:

state - the state of the timer

accumulatedTimeMillis - the accumulated time of the timer

Method Detail

snapshot

public AccumulatedTimerSnapshot 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.

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

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.

toString

public String toString()

Overrides:

toString in class Object