LoggingTool (cdk 2.5 API)

java.lang.Object
- org.openscience.cdk.tools.LoggingTool

All Implemented Interfaces:

ILoggingTool
```
public class LoggingTool
extends Object
implements ILoggingTool
```
Useful for logging messages. Often used as a class static variable instantiated like:
```
 public class SomeClass {
     private static ILoggingTool logger =
         LoggingToolFactory.createLoggingTool(SomeClass.class);
 }
 
```
There is no special reason not to make the logger private and static, as the logging information is closely bound to one specific Class, not subclasses and not instances.
The logger has five logging levels:

DEBUG
Default mode. Used for information you might need to track down the cause of a bug in the source code, or to understand how an algorithm works.
WARNING
This indicates a special situation which is unlike to happen, but for which no special actions need to be taken. E.g. missing information in files, or an unknown atom type. The action is normally something user friendly.
INFO
For reporting informative information to the user that he might easily disregard. Real important information should be given to the user using a GUI element.
FATAL
This level is used for situations that should not have happened *and* that lead to a situation where this program can no longer function (rare in Java).
ERROR
This level is used for situations that should not have happened *and* thus indicate a bug.

Consider that the debugging will not always be turned on. Therefore, it is better not to concatenate string in the logger.debug() call, but have the LoggingTool do this when appropriate. In other words, use:
```
 logger.debug("The String X has this value: ", someString);
 logger.debug("The int Y has this value: ", y);
 
```
instead of:
```
 logger.debug("The String X has this value: " + someString);
 logger.debug("The int Y has this value: " + y);
 
```
For logging calls that require even more computation you can use the isDebugEnabled() method:
```
 if (logger.isDebugEnabled()) {
   logger.info("The 1056389822th prime that is used is: ",
     calculatePrime(1056389822));
 }
 
```
The class uses log4j as a backend if available, and System.err otherwise.
Source code:
master

Belongs to CDK module:
log4j

Field Summary

Fields
Modifier and Type Field and Description

int DEFAULT_STACK_LENGTH
Default number of StackTraceElements to be printed by debug(Exception).
- Fields inherited from interface org.openscience.cdk.tools.ILoggingTool
  DEBUG, ERROR, FATAL, INFO, TRACE, WARN

Fields
Modifier and Type	Field and Description
`int`	`DEFAULT_STACK_LENGTH` Default number of StackTraceElements to be printed by debug(Exception).

Constructor Summary

Constructors
Constructor and Description
`LoggingTool()` Constructs a LoggingTool which produces log lines without any special indication which class the message originates from.
`LoggingTool(Class<?> classInst)` Constructs a LoggingTool which produces log lines indicating them to be for the given Class.
`LoggingTool(Object object)` Constructs a LoggingTool which produces log lines indicating them to be for the Class of the `Object`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`configureLog4j()` Forces the `LoggingTool` to configure the Log4J toolkit.
`static ILoggingTool`	`create(Class<?> sourceClass)` Creates a new `LoggingTool` for the given class.
`void`	`debug(Object object)` Shows DEBUG output for the Object.
`void`	`debug(Object object, Object... objects)` Shows DEBUG output for the given Object's.
`void`	`dumpClasspath()` Outputs the system property for java.class.path.
`void`	`dumpSystemProperties()` Outputs system properties for the operating system and the java version.
`void`	`error(Object object)` Shows ERROR output for the Object.
`void`	`error(Object object, Object... objects)` Shows ERROR output for the given Object's.
`void`	`fatal(Object object)` Shows FATAL output for the Object.
`int`	`getLevel()` Get the current level of this logger.
`void`	`info(Object object)` Shows INFO output for the Object.
`void`	`info(Object object, Object... objects)` Shows INFO output for the given Object's.
`boolean`	`isDebugEnabled()` Use this method for computational demanding debug info.
`void`	`setLevel(int level)` Set the level of this logger.
`void`	`setStackLength(int length)` Sets the number of StackTraceElements to be printed in DEBUG mode when calling `debug(Throwable)`.
`void`	`warn(Object object)` Shows WARN output for the Object.
`void`	`warn(Object object, Object... objects)` Shows WARN output for the given Object's.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_STACK_LENGTH
```
public final int DEFAULT_STACK_LENGTH
```
    Default number of StackTraceElements to be printed by debug(Exception).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LoggingTool
```
public LoggingTool()
```
    Constructs a LoggingTool which produces log lines without any special indication which class the message originates from.
  - LoggingTool
```
public LoggingTool(Object object)
```
    Constructs a LoggingTool which produces log lines indicating them to be for the Class of the Object.
    
    Parameters:
    
    object - Object from which the log messages originate
  - LoggingTool
```
public LoggingTool(Class<?> classInst)
```
    Constructs a LoggingTool which produces log lines indicating them to be for the given Class.
    
    Parameters:
    
    classInst - Class from which the log messages originate
- Method Detail
  - configureLog4j
```
public static void configureLog4j()
```
    Forces the LoggingTool to configure the Log4J toolkit. Normally this should be done by the application that uses the CDK library, but is available for convenience.
  - dumpSystemProperties
```
public void dumpSystemProperties()
```
    Outputs system properties for the operating system and the java version. More specifically: os.name, os.version, os.arch, java.version and java.vendor.
    
    Specified by:
    
    dumpSystemProperties in interface ILoggingTool
  - setStackLength
```
public void setStackLength(int length)
```
    Sets the number of StackTraceElements to be printed in DEBUG mode when calling debug(Throwable). The default value is DEFAULT_STACK_LENGTH.
    
    Specified by:
    
    setStackLength in interface ILoggingTool
    
    Parameters:
    
    length - the new stack length
    
    See Also:
    
    DEFAULT_STACK_LENGTH
  - dumpClasspath
```
public void dumpClasspath()
```
    Outputs the system property for java.class.path.
    
    Specified by:
    
    dumpClasspath in interface ILoggingTool
  - debug
```
public void debug(Object object)
```
    Shows DEBUG output for the Object. If the object is an instanceof Throwable it will output the trace. Otherwise it will use the toString() method.
    
    Specified by:
    
    debug in interface ILoggingTool
    
    Parameters:
    
    object - Object to apply toString() too and output
  - debug
```
public void debug(Object object,
                  Object... objects)
```
    Shows DEBUG output for the given Object's. It uses the toString() method to concatenate the objects.
    
    Specified by:
    
    debug in interface ILoggingTool
    
    Parameters:
    
    object - Object to apply toString() too and output
    
    objects - Object[] to apply toString() too and output
  - error
```
public void error(Object object)
```
    Shows ERROR output for the Object. It uses the toString() method.
    
    Specified by:
    
    error in interface ILoggingTool
    
    Parameters:
    
    object - Object to apply toString() too and output
  - error
```
public void error(Object object,
                  Object... objects)
```
    Shows ERROR output for the given Object's. It uses the toString() method to concatenate the objects.
    
    Specified by:
    
    error in interface ILoggingTool
    
    Parameters:
    
    object - Object to apply toString() too and output
    
    objects - Object[] to apply toString() too and output
  - fatal
```
public void fatal(Object object)
```
    Shows FATAL output for the Object. It uses the toString() method.
    
    Specified by:
    
    fatal in interface ILoggingTool
    
    Parameters:
    
    object - Object to apply toString() too and output
  - info
```
public void info(Object object)
```
    Shows INFO output for the Object. It uses the toString() method.
    
    Specified by:
    
    info in interface ILoggingTool
    
    Parameters:
    
    object - Object to apply toString() too and output
  - info
```
public void info(Object object,
                 Object... objects)
```
    Shows INFO output for the given Object's. It uses the toString() method to concatenate the objects.
    
    Specified by:
    
    info in interface ILoggingTool
    
    Parameters:
    
    object - Object to apply toString() too and output
    
    objects - Object[] to apply toString() too and output
  - warn
```
public void warn(Object object)
```
    Shows WARN output for the Object. It uses the toString() method.
    
    Specified by:
    
    warn in interface ILoggingTool
    
    Parameters:
    
    object - Object to apply toString() too and output
  - warn
```
public void warn(Object object,
                 Object... objects)
```
    Shows WARN output for the given Object's. It uses the toString() method to concatenate the objects.
    
    Specified by:
    
    warn in interface ILoggingTool
    
    Parameters:
    
    object - Object to apply toString() too and output
    
    objects - Object[] to apply toString() too and output
  - isDebugEnabled
```
public boolean isDebugEnabled()
```
    Use this method for computational demanding debug info. For example:
```
 if (logger.isDebugEnabled()) {
   logger.info("The 1056389822th prime that is used is: ",
                calculatePrime(1056389822));
 }
 
```
    Specified by:
    
    isDebugEnabled in interface ILoggingTool
    
    Returns:
    
    true, if debug is enabled
  - create
```
public static ILoggingTool create(Class<?> sourceClass)
```
    Creates a new LoggingTool for the given class.
    
    Parameters:
    
    sourceClass - Class for which logging messages are recorded.
    
    Returns:
    
    A LoggingTool.
  - setLevel
```
public void setLevel(int level)
```
    Set the level of this logger. The level is provided in one of the constants: ILoggingTool.TRACE, ILoggingTool.DEBUG, ILoggingTool.INFO, ILoggingTool.WARN , ILoggingTool.ERROR, ILoggingTool.FATAL. After setting the level only messages above the specified level will be emitted.
    
    Specified by:
    
    setLevel in interface ILoggingTool
    
    Parameters:
    
    level - the level
  - getLevel
```
public int getLevel()
```
    Get the current level of this logger. The level is provided in one of the constants: ILoggingTool.TRACE, ILoggingTool.DEBUG, ILoggingTool.INFO, ILoggingTool.WARN , ILoggingTool.ERROR, ILoggingTool.FATAL.
    
    Specified by:
    
    getLevel in interface ILoggingTool
    
    Returns:
    
    the current level

Class LoggingTool

Field Summary

Fields inherited from interface org.openscience.cdk.tools.ILoggingTool

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_STACK_LENGTH

Constructor Detail

LoggingTool

LoggingTool

LoggingTool

Method Detail

configureLog4j

dumpSystemProperties

setStackLength

dumpClasspath

debug

debug

error

error

fatal

info

info

warn

warn

isDebugEnabled

create

setLevel

getLevel