org.jlf.dataMap
Class DataMapInstrument

java.lang.Object
  |
  +--org.jlf.log.AppInstrument
        |
        +--org.jlf.dataMap.DataMapInstrument

public class DataMapInstrument
extends AppInstrument

This class provides a timer utility to instrument dataMap package code.

See Also:
AppInstrument

Field Summary
 
Fields inherited from class org.jlf.log.AppInstrument
alertTimeOutMilliseconds, instrumentedEventName, outputAlertLoggingLevel, outputLog, outputLoggingLevel, startTime
 
Constructor Summary
protected DataMapInstrument()
          Protect the default constructor, use a parameterized constructor below!
  DataMapInstrument(java.lang.String instrumentedEventName)
          Constructor which accepts the name of the event you are going to instrument.
  DataMapInstrument(java.lang.String instrumentedEventName, int loggingLevel)
          Constructor which accepts the name of the event you are going to instrument and the logging level you are going to log to.
  DataMapInstrument(java.lang.String instrumentedEventName, int loggingLevel, int alertLoggingLevel, long alertTimeOutMilliseconds)
          Constructor which accepts all parameters for creating an instrument.
 
Method Summary
protected static Log getDefaultLog()
          Returns the default Log to log to when writing the output of the instrument.
 
Methods inherited from class org.jlf.log.AppInstrument
getDefaultAlertLoggingLevel, getDefaultAlertTimeOutMilliseconds, getDefaultLoggingLevel, logTime, logTime, resetTimer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataMapInstrument

protected DataMapInstrument()
Protect the default constructor, use a parameterized constructor below!


DataMapInstrument

public DataMapInstrument(java.lang.String instrumentedEventName)
Constructor which accepts the name of the event you are going to instrument. Uses the default values for the Log to log to and the logging level to log at.


DataMapInstrument

public DataMapInstrument(java.lang.String instrumentedEventName,
                         int loggingLevel)
Constructor which accepts the name of the event you are going to instrument and the logging level you are going to log to. Uses the default value for the Log to log to.


DataMapInstrument

public DataMapInstrument(java.lang.String instrumentedEventName,
                         int loggingLevel,
                         int alertLoggingLevel,
                         long alertTimeOutMilliseconds)
Constructor which accepts all parameters for creating an instrument. Starts the timer before returning.

Method Detail

getDefaultLog

protected static Log getDefaultLog()
Returns the default Log to log to when writing the output of the instrument. The default for this class is AppLog.