Class Profiler

java.lang.Object

org.jpos.util.Profiler

All Implemented Interfaces:

Loggeable

public class Profiler
extends Object
implements Loggeable

Simple Profiler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Profiler.Entry	A single timed checkpoint entry recorded by the Profiler.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TO_MILLIS	Conversion factor from nanoseconds to milliseconds.

Constructor Summary

Constructors

Constructor	Description
Profiler()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	checkPoint(String detail)	mark checkpoint
void	dump(PrintStream p, String indent)	Dumps profiler results to the given print stream.
long	getElapsed()	Returns the total elapsed time since the last reset.
long	getElapsedInMillis()	Returns total elapsed time in milliseconds since the last reset.
Profiler.Entry	getEntry(String eventName)	Returns the profiler entry for the given event name.
LinkedHashMap<String, Profiler.Entry>	getEvents()	Returns all profiler events collected since the last reset.
long	getPartial()	Returns the partial elapsed time since the last checkpoint.
long	getPartialInMillis()	Returns partial elapsed time in milliseconds since the last checkpoint.
void	reenable()	Removes the "end" checkpoint so profiling can continue.
void	reset()	reset timers

Methods inherited from class Object

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

Methods inherited from interface Loggeable

dump

Modifier and Type	Method	Description
default void	dump(PrintStream p, String indent, LogRenderer.Type type)	Dumps a representation of this object using the specified renderer type.

Field Details

TO_MILLIS

public static final int TO_MILLIS

Conversion factor from nanoseconds to milliseconds.

See Also:

• Constant Field Values

Constructor Details

Profiler

public Profiler()

Default constructor.

Method Details

reset

public void reset()

reset timers

checkPoint

public void checkPoint(String detail)

mark checkpoint

Parameters:

detail - checkpoint information

getElapsed

public long getElapsed()

Returns the total elapsed time since the last reset.

Returns:

total elapsed time since last reset

getElapsedInMillis

public long getElapsedInMillis()

Returns total elapsed time in milliseconds since the last reset.

Returns:

elapsed time in milliseconds

getPartial

public long getPartial()

Returns the partial elapsed time since the last checkpoint.

Returns:

partial elapsed time since last reset

getPartialInMillis

public long getPartialInMillis()

Returns partial elapsed time in milliseconds since the last checkpoint.

Returns:

partial elapsed time in milliseconds

dump

public void dump(PrintStream p,
 String indent)

Dumps profiler results to the given print stream.

Specified by:

dump in interface Loggeable

Parameters:

p - the output stream

indent - indent prefix

getEvents

public LinkedHashMap<String, Profiler.Entry> getEvents()

Returns all profiler events collected since the last reset.

Returns:

ordered map of event name to Entry

getEntry

public Profiler.Entry getEntry(String eventName)

Returns the profiler entry for the given event name.

Parameters:

eventName - the event name

Returns:

the corresponding Entry, or null if not found

reenable

public void reenable()

Removes the "end" checkpoint so profiling can continue.