com.chemaxon.calculations.common

Class Timer

java.lang.Object

com.chemaxon.calculations.common.Timer

@Beta
public final class Timer
extends Object

Simple timer to measure elapsed times, invocation counts.

Invocation counts are represented as long values.

Please note that this class is marked with Beta annotation, so it can be subject of incompatible changes or removal in later releases.

Constructor Summary

Constructors

Constructor and Description
Timer(String name) Construct started timer.

Method Summary

Modifier and Type	Method and Description
long	getElapsedTime() Elapsed time.
long	getInvocationCount() Get total invocation count.
String	getName() Name of the timer.
long	getStartTime() Start time.
TimerStatistics	getStatistics() Statistics of a stopped timer.
long	invoke() Register one invoceation.
long	invoke(long invocations) Register one or multiple invocations.
void	stop() Stop.
static String	toHumanReadableTimeUnit(double ms) Format to nicely interpretable time unit.
static String	toIecBinaryUnits(long bytes) Format memory units.
static String	toSiPrefixedString(long measure) Format nicely with SI unit prefixes.
String	toString()
String	toString(boolean appendInvocations)

Methods inherited from class java.lang.Object

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

Constructor Detail

Timer

public Timer(String name)

Construct started timer.

Parameters:

name - Timer name

Method Detail

invoke

public long invoke(long invocations)

Register one or multiple invocations.

Parameters:

invocations - Invocation number to register

Returns:

Total invocations count.

Throws:

IllegalStateException - when invoked in stopped state

invoke

public long invoke()

Register one invoceation.

Returns:

Total invocations count

stop

public void stop()

Stop.

getInvocationCount

public long getInvocationCount()

Get total invocation count.

Returns:

total invocation count

getElapsedTime

public long getElapsedTime()

Elapsed time.

Returns:

running time up to this point or up to signalling stop

toHumanReadableTimeUnit

public static String toHumanReadableTimeUnit(double ms)

Format to nicely interpretable time unit.

Parameters:

ms - Time in ms

Returns:

Human readable unit

toIecBinaryUnits

public static String toIecBinaryUnits(long bytes)

Format memory units.

Parameters:

bytes - Byte count

Returns:

Suffices with B/ KiB / MiB / GiB / TiB / PiB

toSiPrefixedString

public static String toSiPrefixedString(long measure)

Format nicely with SI unit prefixes.

Parameters:

measure - Value to format

Returns:

value with optionally k, M, G, T, P unit prefixes attached.

See Also:

http://en.wikipedia.org/wiki/Metric_prefix

toString

public String toString(boolean appendInvocations)

getStatistics

public TimerStatistics getStatistics()

Statistics of a stopped timer.

Returns:

Detailed statistics

Throws:

IllegalStateException - when timer is not stopped or no invocations made.

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Name of the timer.

Returns:

name

getStartTime

public long getStartTime()

Start time.

Returns:

start time