com.cgiams.esl.common.logging
Class LoggingUtil

java.lang.Object
  extended bycom.cgiams.esl.common.logging.LoggingUtil

public class LoggingUtil
extends java.lang.Object

This Singleton class provides common utility methods for logging. Specifically, it provides one line method signatures that you can add to your code for providing common Begin and End method debugging. This makes the calling code much cleaner to look at and provide the same functional purpose.

Modification History
Programmer Date Description
Scott Bowers 08/11/2005 Original Author

Author:
sbowers

Method Summary
static LoggingUtil getInstance()
          Return the Singleton instance of the ValidationUtil.
 void logDebugMethodBegin(org.apache.commons.logging.Log ao_logger)
          Logs a debug message that returns the Class name and method name in the message followed by the text "...Beginning".
 void logDebugMethodEnd(org.apache.commons.logging.Log ao_logger)
          Logs a debug message that returns the Class name and method name in the message followed by the text "...Ending".
 void logDebugMethodMessage(org.apache.commons.logging.Log ao_logger, java.lang.String as_message)
          Logs a debug message that returns the Class name and method name in the message followed by the text of the incoming message.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static LoggingUtil getInstance()
Return the Singleton instance of the ValidationUtil.

Returns:
The singleton instance of the ValidationUtil class.

logDebugMethodBegin

public void logDebugMethodBegin(org.apache.commons.logging.Log ao_logger)
Logs a debug message that returns the Class name and method name in the message followed by the text "...Beginning". This assumes that the class calling this method has logging level set to display Debug messages.

Parameters:
ao_logger - The calling classes Log object.

logDebugMethodEnd

public void logDebugMethodEnd(org.apache.commons.logging.Log ao_logger)
Logs a debug message that returns the Class name and method name in the message followed by the text "...Ending". This assumes that the class calling this method has logging level set to display Debug messages.

Parameters:
ao_logger - The calling classes Log object.

logDebugMethodMessage

public void logDebugMethodMessage(org.apache.commons.logging.Log ao_logger,
                                  java.lang.String as_message)
Logs a debug message that returns the Class name and method name in the message followed by the text of the incoming message. This assumes that the class calling this method has logging level set to display Debug messages.

Parameters:
ao_logger - The calling classes Log object.
as_message - The message to display along with caller's class and method name.