org.openscience.cdk.tools

Class LoggingToolFactory

java.lang.Object

org.openscience.cdk.tools.LoggingToolFactory

public class LoggingToolFactory
extends Object

Factory used to instantiate a ILoggingTool. To get an instance, run:

 public class SomeClass {
   private static ILoggingTool logger;

   static {
     logger = LoggingToolFactory.createLoggingTool(SomeClass.class);
   }
 }
 

Source code:

master

Belongs to CDK module:

core

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LOGGING_TOOL_CLASS Default logging tool.
static String	STDOUT_LOGGING_TOOL_CLASS Back-up logging tool.

Constructor Summary

Constructors

Constructor and Description
LoggingToolFactory()

Method Summary

Modifier and Type	Method and Description
static ILoggingTool	createLoggingTool(Class<?> sourceClass) Dynamically create a ILoggingTool for the given sourceClass.
static Class<? extends ILoggingTool>	getLoggingToolClass() Gets the currently used ILoggingTool implementation.
static void	setLoggingToolClass(Class<? extends ILoggingTool> loggingTool) Sets the ILoggingTool implementation to be used.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOGGING_TOOL_CLASS

public static final String DEFAULT_LOGGING_TOOL_CLASS

Default logging tool. Currently, the log4j based one.

See Also:

Constant Field Values

STDOUT_LOGGING_TOOL_CLASS

public static final String STDOUT_LOGGING_TOOL_CLASS

Back-up logging tool. Currently, a tool that outputs to System.out.

See Also:

Constant Field Values

Constructor Detail

LoggingToolFactory

public LoggingToolFactory()

Method Detail

setLoggingToolClass

public static void setLoggingToolClass(Class<? extends ILoggingTool> loggingTool)

Sets the ILoggingTool implementation to be used.

Parameters:

loggingTool - The new ILoggingTool.

See Also:

getLoggingToolClass()

getLoggingToolClass

public static Class<? extends ILoggingTool> getLoggingToolClass()

Gets the currently used ILoggingTool implementation.

Returns:

The currently used ILoggingTool.

See Also:

setLoggingToolClass(Class)

createLoggingTool

public static ILoggingTool createLoggingTool(Class<?> sourceClass)

Dynamically create a ILoggingTool for the given sourceClass.

Parameters:

sourceClass - Class for which the ILoggingTool should be constructed.

Returns:

An ILoggingTool implementation.