org.apache.juneau.utils

Class MethodExecStats

java.lang.Object

org.apache.juneau.utils.MethodExecStats

All Implemented Interfaces:

Comparable<MethodExecStats>

@Bean(bpi="method,runs,running,errors,minTime,maxTime,avgTime,totalTime,exceptions")
public class MethodExecStats
extends Object
implements Comparable<MethodExecStats>

Basic timing information. Keeps track of number of starts/finishes on tasks and keeps an average run time.

Constructor Summary

Constructors

Constructor and Description
MethodExecStats(Method method) Constructor.
MethodExecStats(Method method, Class<?> stackTraceStopClass) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(MethodExecStats o)
void	error(Throwable e) Call when an error occurs.
void	finished(long nanoTime) Call when task is finished.
int	getAvgTime() Returns the average execution time.
int	getErrors() Returns the number of times the error(Throwable) method was called.
List<StackTraceInfo>	getExceptions() Returns information on all stack traces of all exceptions encountered.
int	getMaxTime() Returns the max execution time.
String	getMethod() Returns the method name of these stats.
int	getMinTime() Returns the max execution time.
int	getRunning() Returns the number currently running method invocations.
int	getRuns() Returns the number of times the started() method was called.
long	getTotalTime() Returns the total execution time.
void	started() Call when task is started.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodExecStats

public MethodExecStats(Method method,
                       Class<?> stackTraceStopClass)

Constructor.

Parameters:

method - Arbitrary label. Should be kept to less than 50 characters.

stackTraceStopClass - Don't calculate stack traces when this class is encountered.

MethodExecStats

public MethodExecStats(Method method)

Constructor.

Parameters:

method - Arbitrary label. Should be kept to less than 50 characters.

Method Detail

started

public void started()

Call when task is started.

finished

public void finished(long nanoTime)

Call when task is finished.

Parameters:

nanoTime - The execution time of the task in nanoseconds.

error

public void error(Throwable e)

Call when an error occurs.

Parameters:

e - The exception thrown. Can be null.

getMethod

public String getMethod()

Returns the method name of these stats.

Returns:

The method name of these stats.

getRuns

public int getRuns()

Returns the number of times the started() method was called.

Returns:

The number of times the started() method was called.

getRunning

public int getRunning()

Returns the number currently running method invocations.

Returns:

The number of currently running method invocations.

getErrors

public int getErrors()

Returns the number of times the error(Throwable) method was called.

Returns:

The number of times the error(Throwable) method was called.

getMinTime

public int getMinTime()

Returns the max execution time.

Returns:

The average execution time in milliseconds.

getMaxTime

public int getMaxTime()

Returns the max execution time.

Returns:

The average execution time in milliseconds.

getAvgTime

public int getAvgTime()

Returns the average execution time.

Returns:

The average execution time in milliseconds.

getTotalTime

public long getTotalTime()

Returns the total execution time.

Returns:

The total execution time in milliseconds.

getExceptions

public List<StackTraceInfo> getExceptions()

Returns information on all stack traces of all exceptions encountered.

Returns:

Information on all stack traces of all exceptions encountered.

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(MethodExecStats o)

Specified by:

compareTo in interface Comparable<MethodExecStats>