net.obvj.performetrics

Class Counter

java.lang.Object

net.obvj.performetrics.Counter

public class Counter
extends Object

An object containing units before and units after for a particular unit type

Author:

oswaldo.bapvic.jr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Counter.Type An enumeration of all types of measurement supported

Field Summary

Fields

Modifier and Type	Field and Description
static TimeUnit	DEFAULT_UNIT The default time unit to be stored (nanoseconds) if no specific time unit informed
protected static String	STRING_FORMAT

Constructor Summary

Constructors

Constructor and Description
Counter(Counter.Type type) Builds this Counter object with default time unit of nanoseconds.
Counter(Counter.Type type, TimeUnit timeUnit) Builds this Counter object with the given type and time unit.

Method Summary

Modifier and Type	Method and Description
void	after() Set the units after with this counter's default data fetch strategy
void	before() Set the units before with this counter's default data fetch strategy
long	elapsedTime()
long	elapsedTime(TimeUnit timeUnit) Returns the elapsed time, in a given TimeUnit.
TimeUnit	getDefaultTimeUnit()
Counter.Type	getType()
long	getUnitsAfter()
long	getUnitsBefore()
void	setUnitsAfter(long unitsAfter)
void	setUnitsBefore(long unitsBefore)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

STRING_FORMAT

protected static final String STRING_FORMAT

See Also:

Constant Field Values

DEFAULT_UNIT

public static final TimeUnit DEFAULT_UNIT

The default time unit to be stored (nanoseconds) if no specific time unit informed

Constructor Detail

Counter

public Counter(Counter.Type type)

Builds this Counter object with default time unit of nanoseconds.

This is equivalent to: new Counter(type, TimeUnit.NANOSECONDS}

Parameters:

type - the type to set

Counter

public Counter(Counter.Type type,
               TimeUnit timeUnit)

Builds this Counter object with the given type and time unit.

Parameters:

type - the type to set

timeUnit - the unit to set

Method Detail

getUnitsBefore

public long getUnitsBefore()

Returns:

the units before

setUnitsBefore

public void setUnitsBefore(long unitsBefore)

Parameters:

unitsBefore - the units to be set

getUnitsAfter

public long getUnitsAfter()

Returns:

the units after

setUnitsAfter

public void setUnitsAfter(long unitsAfter)

Parameters:

unitsAfter - the units to be set

getType

public Counter.Type getType()

Returns:

the type of measurement

getDefaultTimeUnit

public TimeUnit getDefaultTimeUnit()

Returns:

the default time unit

before

public void before()

Set the units before with this counter's default data fetch strategy

after

public void after()

Set the units after with this counter's default data fetch strategy

elapsedTime

public long elapsedTime()

Returns:

the difference between units before and units after, if both units are set; or the difference between units before and the current units, retrieved by the counter's default data fetch strategy, if the units after ate not set.

elapsedTime

public long elapsedTime(TimeUnit timeUnit)

Returns the elapsed time, in a given TimeUnit.

Parameters:

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

Returns:

the difference between units before and units after, in the given time unit

toString

public String toString()

Overrides:

toString in class Object