org.sormula.log

Class SormulaLoggerFactory

java.lang.Object

org.sormula.log.SormulaLoggerFactory

public class SormulaLoggerFactory
extends java.lang.Object

Factory for supplying logger classes that are used by Sormula classes. This factory decouples Sormula logging from any specific logging library and allows you to use the logging library of your choice or no logging library.

Use setLoggerClass(Class) to change the default logger to one of the implementations of SormulaLogger in org.sormula.log package or any implementation of SormulaLogger.

The default logger class is Slf4jSormulaLogger for backward compatibility since previous versions of Sormula used ClassLogger which is dependent upon SLF4J. The default logger does not require any SLF4J jars to be on classpath at runtime if no logging is desired.

Since:

4.3

Author:

Jeff Miller

Constructor Summary

Constructors

Constructor and Description
SormulaLoggerFactory()

Method Summary

Modifier and Type	Method and Description
static SormulaLogger	getClassLogger() Gets a logger with logical log name as package name of the caller of this method.
static java.lang.Class<? extends SormulaLogger>	getLoggerClass() Gets the logger class to use in getClassLogger().
static void	setLoggerClass(java.lang.Class<? extends SormulaLogger> loggerClass) Sets the logger class to be used by Sormula.
static void	setLoggerClass(java.lang.String loggerClassName) Loads class with name provided in loggerClassName and invokes setLoggerClass(Class).

Methods inherited from class java.lang.Object

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

Constructor Detail

SormulaLoggerFactory

public SormulaLoggerFactory()

Method Detail

getClassLogger

public static SormulaLogger getClassLogger()

Gets a logger with logical log name as package name of the caller of this method. For example, org.sormula.something.SomeClass invokes getClassLogger() then a SormulaLogger with the logical log name of org.sormula.something would be returned.

Returns:

logger to use

getLoggerClass

public static java.lang.Class<? extends SormulaLogger> getLoggerClass()

Gets the logger class to use in getClassLogger(). The default is Slf4jSormulaLogger for backward compatibility since the original logger used by Sormula was ClassLogger which is dependent upon SLF4J.

Returns:

class of logger to return with getClassLogger()

setLoggerClass

public static void setLoggerClass(java.lang.String loggerClassName)
                           throws LogException

Loads class with name provided in loggerClassName and invokes setLoggerClass(Class).

Parameters:

loggerClassName - the fully qualified name of the class that implements SormulaLogger

Throws:

LogException - if error, see exception message for reason

setLoggerClass

public static void setLoggerClass(java.lang.Class<? extends SormulaLogger> loggerClass)
                           throws LogException

Sets the logger class to be used by Sormula. New instances of the logger class will be created for use by Sormula. The logger class must have a constructor of one parameter of type String.

Setting the logger class determines the logger for Sormula classes that are not already loaded by the class loader. Sormula classes have static reference to SormulaLogger objects that are initialized when the Sormula class was loaded into memory. Typically setLoggerClass(Class) should be used prior to using any Sormula classes.

Parameters:

loggerClass - any class that implements SormulaLogger interface

Throws:

LogException - if error, see exception message for reason