fr.lirmm.graphik.util.profiler

Class AbstractProfiler

java.lang.Object

fr.lirmm.graphik.util.profiler.AbstractProfiler

All Implemented Interfaces:

Profiler

Direct Known Subclasses:

CPUTimeProfiler, RealTimeProfiler

public abstract class AbstractProfiler
extends Object
implements Profiler

This class is a profiler with a timer feature (ms)

Author:

Clément Sipieter (INRIA) <clement@6pi.fr>

Constructor Summary

Constructors

Constructor and Description
AbstractProfiler()
AbstractProfiler(PrintStream out)
AbstractProfiler(PrintStream out, TimeUnit timeUnit)
AbstractProfiler(TimeUnit timeUnit)

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all data.
void	clear(String key) Clear data attached to the specfied key.
Set<Map.Entry<String,Object>>	entrySet()
Object	get(String key) Get data/time attached to the specified key.
Map<String,Object>	getMap()
protected abstract long	getTime() Return time in nanoseconds
TimeUnit	getTimeUnit()
void	incr(String key, int value) Increment an integer attached to the specified key.
boolean	isProfilingEnabled()
Set<String>	keySet()
void	put(String key, Object value) Map miscellaneous data on the specified key.
void	setDateFormat(String pattern) Defines the date format used for displaying when the output stream is set.
void	setOutputStream(PrintStream out) Sets the output stream.
void	start(String key) Start a timer with a specified key/identifier.
void	stop(String key) Stop the timer with the specified key.
String	toString()
void	trace(String... strings) If the output stream is set, print this strings.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProfiler

public AbstractProfiler()

AbstractProfiler

public AbstractProfiler(PrintStream out)

AbstractProfiler

public AbstractProfiler(TimeUnit timeUnit)

AbstractProfiler

public AbstractProfiler(PrintStream out,
                        TimeUnit timeUnit)

Method Detail

isProfilingEnabled

public boolean isProfilingEnabled()

Specified by:

isProfilingEnabled in interface Profiler

setDateFormat

public void setDateFormat(String pattern)

Defines the date format used for displaying when the output stream is set.

Specified by:

setDateFormat in interface Profiler

setOutputStream

public void setOutputStream(PrintStream out)

Sets the output stream.

Specified by:

setOutputStream in interface Profiler

Parameters:

out -

getTimeUnit

public TimeUnit getTimeUnit()

Specified by:

getTimeUnit in interface Profiler

Returns:

the TimeUnit in used.

start

public void start(String key)

Start a timer with a specified key/identifier. If you recall this method with the same key, you will erase the start time for the key.

Specified by:

start in interface Profiler

Parameters:

key -

stop

public void stop(String key)

Stop the timer with the specified key. The get method will return the elapsed time between start and stop calls. You should called the start method with the same key before.

Specified by:

stop in interface Profiler

Parameters:

key -

put

public void put(String key,
                Object value)

Map miscellaneous data on the specified key. You can retrieve the data using the get method.

Specified by:

put in interface Profiler

Parameters:

key -

value -

incr

public void incr(String key,
                 int value)

Increment an integer attached to the specified key.

Specified by:

incr in interface Profiler

Parameters:

key -

value -

get

public Object get(String key)

Description copied from interface: Profiler

Get data/time attached to the specified key.

Specified by:

get in interface Profiler

Returns:

data/time attached to the specified key.

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Profiler

getMap

public Map<String,Object> getMap()

Specified by:

getMap in interface Profiler

Returns:

the map behind this profiler.

clear

public void clear(String key)

Clear data attached to the specfied key.

Specified by:

clear in interface Profiler

Parameters:

key -

clear

public void clear()

Clear all data.

Specified by:

clear in interface Profiler

trace

public void trace(String... strings)

If the output stream is set, print this strings.

Specified by:

trace in interface Profiler

keySet

public Set<String> keySet()

Specified by:

keySet in interface Profiler

Returns:

a Set of all keys used.

toString

public String toString()

Overrides:

toString in class Object

getTime

protected abstract long getTime()

Return time in nanoseconds

Returns:

time in nanoseconds.