net.obvj.performetrics

Class Counter

java.lang.Object

net.obvj.performetrics.Counter

public class Counter
extends Object

An object that stores time units of a particular type for elapsed time evaluation.

The associated counter type defines the time fetch strategy applied by the methods setUnitsBefore() and setUnitsAfter().

Once the units are set, calling elapsedTime() will return a Duration that represents either:

• the elapsed time between calls to setUnitsBefore() and setUnitsAfter() provided that both methods have been called before; or
• the elapsed time between calls to setUnitsBefore() and elapsedTime() if setUnitsAfter() was not called

Optionally, call elapsedTime(TimeUnit) to return the total elapsed time in a specific time unit.

Author:

oswaldo.bapvic.jr

See Also:

Counter.Type, Duration, ConversionMode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Counter.Type Enumerates all supported counter types, defining a particular time fetch strategy for each of them.

Constructor Summary

Constructors

Constructor and Description
Counter(Counter.Type type) Builds a Counter with a given type and default time unit.
Counter(Counter.Type type, TimeUnit timeUnit) Builds a Counter with the given type and time unit.
Counter(Counter.Type type, TimeUnit timeUnit, ConversionMode conversionMode) Builds a Counter with the given type, time unit, and conversion mode.

Method Summary

Modifier and Type	Method and Description
Duration	elapsedTime() Returns the elapsed time.
double	elapsedTime(TimeUnit timeUnit) Returns the elapsed time in the specified TimeUnit.
double	elapsedTime(TimeUnit timeUnit, ConversionMode conversionMode) Returns the elapsed time, in a given TimeUnit, with a custom ConversionMode.
ConversionMode	getConversionMode() Returns the ConversionMode associated with this counter.
TimeUnit	getTimeUnit() Returns the time unit associated with this counter.
Counter.Type	getType() Returns the Counter.Type associated with this counter.
long	getUnitsAfter() Returns the value of the unitsAfter field.
long	getUnitsBefore() Returns the value of the unitsBefore field.
void	setUnitsAfter(long unitsAfter) Populates the unitsAfter field with an arbitrary value.
void	setUnitsBefore(long unitsBefore) Populates the unitsBefore field with an arbitrary value.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Counter

public Counter(Counter.Type type)

Builds a Counter with a given type and default time unit.

Parameters:

type - the type to set; cannot be null

Throws:

NullPointerException - if the specified type is null

Counter

public Counter(Counter.Type type,
               TimeUnit timeUnit)

Builds a Counter with the given type and time unit.

Parameters:

type - the type to set; cannot be null

timeUnit - the time unit to set

Throws:

NullPointerException - if the specified type is null

Counter

public Counter(Counter.Type type,
               TimeUnit timeUnit,
               ConversionMode conversionMode)

Builds a Counter with the given type, time unit, and conversion mode.

Parameters:

type - the type to set; cannot be null

timeUnit - the time unit to set

conversionMode - the ConversionMode to be applied

Throws:

NullPointerException - if the specified type is null

Since:

2.0.0

Method Detail

getUnitsBefore

public long getUnitsBefore()

Returns the value of the unitsBefore field.

Returns:

the value of the unitsBefore field

setUnitsBefore

public void setUnitsBefore(long unitsBefore)

Populates the unitsBefore field with an arbitrary value.

Parameters:

unitsBefore - the units to be set

getUnitsAfter

public long getUnitsAfter()

Returns the value of the unitsAfter field.

Returns:

the value of the unitsAfter field

setUnitsAfter

public void setUnitsAfter(long unitsAfter)

Populates the unitsAfter field with an arbitrary value.

Parameters:

unitsAfter - the units to be set

getType

public Counter.Type getType()

Returns the Counter.Type associated with this counter.

Returns:

the Counter.Type associated with this counter

getTimeUnit

public TimeUnit getTimeUnit()

Returns the time unit associated with this counter.

Returns:

the time unit associated with this counter

getConversionMode

public ConversionMode getConversionMode()

Returns the ConversionMode associated with this counter.

Returns:

the ConversionMode associated with this counter

Since:

2.0.0

elapsedTime

public Duration elapsedTime()

Returns the elapsed time.

Returns:

the difference between unitsBefore and unitsAfter, if both units are set; or the difference between unitsBefore and the current value retrieved by the counter's time source, if unitsAfter is not set.

elapsedTime

public double elapsedTime(TimeUnit timeUnit)

Returns the elapsed time in the specified TimeUnit.

Parameters:

timeUnit - the time unit to which the elapsed time will be converted

Returns:

the difference between unitsBefore and unitsAfter, if both units are set; or the difference between unitsBefore and the current value retrieved by the counter's time source, if unitsAfter is not set. The value is converted into the specified time unit applying the default conversion mode.

elapsedTime

public double elapsedTime(TimeUnit timeUnit,
                          ConversionMode conversionMode)

Returns the elapsed time, in a given TimeUnit, with a custom ConversionMode.

Parameters:

timeUnit - the time unit to which the elapsed time will be converted

conversionMode - the ConversionMode to be used

Returns:

the difference between unitsBefore and unitsAfter, if both units are set; or the difference between unitsBefore and the current value retrieved by the counter's time source, if unitsAfter is not set. The value is converted into the specified time unit applying the given conversion mode.

Since:

2.0.0

toString

public String toString()

Returns a string representation of this object.

Overrides:

toString in class Object

See Also:

Object.toString()