net.sf.mmm.util.date.api

Class TimeMeasure

java.lang.Object

net.sf.mmm.util.date.api.TimeMeasure

public class TimeMeasure
extends Object

This class makes it very easy to do performance monitoring. It can be used as following:

 TimeMeasure measure = new TimeMeasure();
 try {
   doSomething();
   measure.succeed();
 } finally {
   measure.log(getLogger(), "Something");
 }
 

Since:

4.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	TimeMeasure.Result The state of the completion.

Field Summary

Fields

Modifier and Type	Field and Description
private long	duration The end time.
private TimeMeasure.Result	result The TimeMeasure.Result if duration time has been set and measure is completed or null if still in progress.
private long	start The start time.

Constructor Summary

Constructors

Constructor and Description
TimeMeasure() The constructor.

Method Summary

Modifier and Type	Method and Description
private void	complete(TimeMeasure.Result finalResult)
void	fail() This method is to be called once after the operation(s) to measure failed (e.g.
void	failIfNotSucceeded() Invokes fail() if succeed() has not been invoked before.
String	getDurationAsString()
long	getDurationInNanos()
boolean	isCompleted()
boolean	isFailure()
boolean	isSuccess()
void	log(org.slf4j.Logger logger, Object operation) Calls failIfNotSucceeded() and the logs the status and duration of this measure.
private void	requireCompleted() Throws an IllegalStateException if not completed.
void	succeed() This method is to be called once after the operation(s) to measure has successfully completed.

Methods inherited from class java.lang.Object

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

Field Detail

start

private final long start

The start time.

duration

private long duration

The end time.

result

private TimeMeasure.Result result

The TimeMeasure.Result if duration time has been set and measure is completed or null if still in progress.

Constructor Detail

TimeMeasure

public TimeMeasure()

The constructor.

Method Detail

succeed

public void succeed()

This method is to be called once after the operation(s) to measure has successfully completed.

fail

public void fail()

This method is to be called once after the operation(s) to measure failed (e.g. in an catch block).

failIfNotSucceeded

public void failIfNotSucceeded()

Invokes fail() if succeed() has not been invoked before.

isFailure

public boolean isFailure()

Returns:

true if failed, false otherwise.

isSuccess

public boolean isSuccess()

Returns:

true if succeeded, false otherwise.

isCompleted

public boolean isCompleted()

Returns:

true if completed (isSuccess() or isFailure()), false otherwise.

log

public void log(org.slf4j.Logger logger,
                Object operation)

Calls failIfNotSucceeded() and the logs the status and duration of this measure.

Parameters:

logger - is the Logger.

operation - represents the operation that was measured. Typically a String. Its string representation is logged and shall be a brief description of the measured operation.

getDurationInNanos

public long getDurationInNanos()
                        throws IllegalStateException

Returns:

the duration in nanoseconds.

Throws:

IllegalStateException - if not completed.

getDurationAsString

public String getDurationAsString()
                           throws IllegalStateException

Returns:

the duration in a human readable format.

Throws:

IllegalStateException - if not completed.

requireCompleted

private void requireCompleted()

Throws an IllegalStateException if not completed.

complete

private void complete(TimeMeasure.Result finalResult)

Parameters:

finalResult - is the TimeMeasure.Result to set together with the current end time.