oemware.core.util
Class TraceUtils

java.lang.Object
  oemware.core.util.TraceUtils

public final class TraceUtils
extends java.lang.Object

The trace log utils. Used to determine exection time and log.

note: These utils create thread local objects so the class may not be ideal in short/frequent traces.

This object is a singleton.

 Usage:
 TraceUtils.getInstance().startTrace(this.class+"test", mLog);

 ... do something ...

 TraceUtils.getInstance().stopTrace("test");
 

Version:

$Id: TraceUtils.java 13 2008-06-15 19:43:04Z oemware $

Method Summary

static TraceUtils	getInstance()
long	startDebugTrace(java.lang.String pTraceName, org.apache.commons.logging.Log pLog) Start the debug trace.
long	startDebugTrace(java.lang.String pTraceName, org.apache.commons.logging.Log pLog, long pWarnTime, long pErrorTime) Start the debug trace.
long	startInfoTrace(java.lang.String pTraceName, org.apache.commons.logging.Log pLog) Start the info trace.
long	startInfoTrace(java.lang.String pTraceName, org.apache.commons.logging.Log pLog, long pWarnTime, long pErrorTime) Start the info trace.
long	startTrace(java.lang.String pTraceName, org.apache.commons.logging.Log pLog) Start the trace.
long	startTrace(java.lang.String pTraceName, org.apache.commons.logging.Log pLog, long pWarnTime, long pErrorTime) Start the trace.
void	stopDebugTrace(java.lang.String pTraceName) Stop the debug trace.
void	stopInfoTrace(java.lang.String pTraceName) Stop the info trace.
long	stopTrace(java.lang.String pTraceName) Stop the trace.

Methods inherited from class java.lang.Object

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

Method Detail

startTrace

public final long startTrace(java.lang.String pTraceName,
                             org.apache.commons.logging.Log pLog,
                             long pWarnTime,
                             long pErrorTime)

Start the trace.

Parameters:

pTraceName - The trace name.

pLog - The log.

pWarnTime - The warn time.

pErrorTime - The time to write an error message.

startTrace

public final long startTrace(java.lang.String pTraceName,
                             org.apache.commons.logging.Log pLog)

Start the trace.

Parameters:

pTraceName - The trace name.

pLog - The log.

startDebugTrace

public final long startDebugTrace(java.lang.String pTraceName,
                                  org.apache.commons.logging.Log pLog,
                                  long pWarnTime,
                                  long pErrorTime)

Start the debug trace.

Parameters:

pTraceName - The trace name.

pLog - The log.

pWarnTime - The warn time.

pErrorTime - The time to write an error message.

startDebugTrace

public final long startDebugTrace(java.lang.String pTraceName,
                                  org.apache.commons.logging.Log pLog)

Start the debug trace.

Parameters:

pTraceName - The trace name.

pLog - The log.

stopDebugTrace

public final void stopDebugTrace(java.lang.String pTraceName)

Stop the debug trace.

Parameters:

pTraceName - The trace name.

startInfoTrace

public final long startInfoTrace(java.lang.String pTraceName,
                                 org.apache.commons.logging.Log pLog,
                                 long pWarnTime,
                                 long pErrorTime)

Start the info trace.

Parameters:

pTraceName - The trace name.

pLog - The log.

pWarnTime - The warn time.

pErrorTime - The time to write an error message.

startInfoTrace

public final long startInfoTrace(java.lang.String pTraceName,
                                 org.apache.commons.logging.Log pLog)

Start the info trace.

Parameters:

pTraceName - The trace name.

pLog - The log.

stopInfoTrace

public final void stopInfoTrace(java.lang.String pTraceName)

Stop the info trace.

Parameters:

pTraceName - The trace name.

stopTrace

public final long stopTrace(java.lang.String pTraceName)

Stop the trace.

Parameters:

pTraceName - The trace name.

getInstance

public static final TraceUtils getInstance()