org.openscience.cdk.tools

Class SystemOutLoggingTool

java.lang.Object

org.openscience.cdk.tools.SystemOutLoggingTool

All Implemented Interfaces:

ILoggingTool

public class SystemOutLoggingTool
extends Object
implements ILoggingTool

Implementation of the ILoggingTool interface that sends output to the System.err channel.

Source code:

master

Belongs to CDK module:

core

Field Summary

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

DEBUG, DEFAULT_STACK_LENGTH, ERROR, FATAL, INFO, TRACE, WARN

Constructor Summary

Constructors

Constructor and Description
SystemOutLoggingTool(Class<?> classInst) Constructs a ILoggingTool which produces log lines indicating them to be for the given Class.

Method Summary

Modifier and Type	Method and Description
static ILoggingTool	create(Class<?> sourceClass) Creates a new SystemOutLoggingTool 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.
protected void	setDebugEnabled(boolean enabled) Deprecated. use setLevel(int)
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

Constructor Detail

SystemOutLoggingTool

public SystemOutLoggingTool(Class<?> classInst)

Constructs a ILoggingTool which produces log lines indicating them to be for the given Class.

Parameters:

classInst - Class from which the log messages originate

Method Detail

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:

ILoggingTool.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 SystemOutLoggingTool for the given class.

Parameters:

sourceClass - Class for which logging messages are recorded.

Returns:

A SystemOutLoggingTool.

setDebugEnabled

@Deprecated
protected void setDebugEnabled(boolean enabled)

Deprecated. use setLevel(int)

Protected method which must not be used, except for testing purposes.

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