ca.uhn.log.HapiLogFactory Maven / Gradle / Ivy
/*
* HapiLogFactory.java
*
* Created on May 7, 2003 at 2:19:17 PM
*/
package ca.uhn.log;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Factory for creating {@link HapiLog} instances. It is factory
* that delegates the discovery process to the LogFactory
* class and wraps the discovered Log with a new instance of
* the HapiLog class.
*
* @author Alexei Guevara
* @version $Revision: 1.1 $ updated on $Date: 2007/02/19 02:24:52 $ by $Author: jamesagnew $
*/
public final class HapiLogFactory {
/**
* Do not allow instantiation.
*/
private HapiLogFactory() {
}
/**
* Convenience method to return a named HAPI logger, without the application
* having to care about factories.
*
* @param clazz Class for which a log name will be derived
*
* @exception LogConfigurationException if a suitable Log
* instance cannot be returned
*/
public static HapiLog getHapiLog( Class clazz ) {
HapiLog retVal = null;
Log log = LogFactory.getLog( clazz );
retVal = new HapiLogImpl( log );
return retVal;
}
/**
* Convenience method to return a named HAPI logger, without the application
* having to care about factories.
*
* @param name Logical name of the Log instance to be
* returned (the meaning of this name is only known to the underlying
* logging implementation that is being wrapped)
*
* @exception LogConfigurationException if a suitable Log
* instance cannot be returned
*/
public static HapiLog getHapiLog( String name ) {
HapiLog retVal = null;
Log log = LogFactory.getLog( name );
retVal = new HapiLogImpl( log );
return retVal;
}
}