fr.lirmm.graphik.util.profiler

Interface Profiler

All Known Implementing Classes:

AbstractProfiler, CPUTimeProfiler, NoProfiler, RealTimeProfiler

public interface Profiler

Author:

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

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()
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.
void	trace(String... strings) If the output stream is set, print this strings.

Method Detail

setDateFormat

void setDateFormat(String pattern)

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

setOutputStream

void setOutputStream(PrintStream out)

Sets the output stream.

Parameters:

out -

isProfilingEnabled

boolean isProfilingEnabled()

start

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.

Parameters:

key -

stop

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.

Parameters:

key -

put

void put(String key,
         Object value)

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

Parameters:

key -

value -

incr

void incr(String key,
          int value)

Increment an integer attached to the specified key.

Parameters:

key -

value -

get

Object get(String key)

Get data/time attached to the specified key.

Parameters:

key -

Returns:

data/time attached to the specified key.

entrySet

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

clear

void clear(String key)

Clear data attached to the specfied key.

Parameters:

key -

clear

void clear()

Clear all data.

trace

void trace(String... strings)

If the output stream is set, print this strings.

Parameters:

strings -

keySet

Set<String> keySet()

Returns:

a Set of all keys used.

getMap

Map<String,Object> getMap()

Returns:

the map behind this profiler.

getTimeUnit

TimeUnit getTimeUnit()

Returns:

the TimeUnit in used.