org.waarp.common.logging

Class AbstractWaarpLogger

java.lang.Object

org.waarp.common.logging.AbstractWaarpLogger

All Implemented Interfaces:

Serializable, WaarpLogger

Direct Known Subclasses:

WaarpJdkLogger, WaarpSlf4JLogger

public abstract class AbstractWaarpLogger
extends Object
implements WaarpLogger, Serializable

A skeletal implementation of WaarpLogger. This class implements all methods that have a WaarpLogLevel parameter by default to call specific logger methods such as WaarpLogger.info(String) or WaarpLogger.isInfoEnabled().

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWaarpLogger(String name) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	debug(Throwable t) Log an exception (throwable) at the DEBUG level.
void	error(Throwable t) Log an exception (throwable) at the ERROR level.
static String	getImmediateMethodAndLine() To be used in message for logger (rank 2) like logger.warn(code,"message:"+getImmediateMethodAndLine(),null);
static String	getLoggerMethodAndLine() To be used only by Logger (rank 5)
static String	getLoggerMethodAndLineCallee(int deep) To be used only by Logger (rank 5)
protected static String	getRankMethodAndLine(int rank)
void	info(Throwable t) Log an exception (throwable) at the INFO level.
boolean	isEnabled(WaarpLogLevel level) Is the logger instance enabled for the specified level?
void	log(WaarpLogLevel level, String msg) Log a message at the specified level.
void	log(WaarpLogLevel level, String format, Object... arguments) Log a message at the specified level according to the specified format and arguments.
void	log(WaarpLogLevel level, String format, Object arg) Log a message at the specified level according to the specified format and argument.
void	log(WaarpLogLevel level, String format, Object argA, Object argB) Log a message at the specified level according to the specified format and arguments.
void	log(WaarpLogLevel level, String msg, Throwable cause) Log an exception (throwable) at the specified level with an accompanying message.
void	log(WaarpLogLevel level, Throwable cause) Log an exception (throwable) at the specified level.
String	name() Return the name of this WaarpLogger instance.
protected Object	readResolve()
static String	simpleClassName(Class<?> clazz)
static String	simpleClassName(Object o)
String	toString()
void	trace(Throwable t) Log an exception (throwable) at the TRACE level.
void	warn(Throwable t) Log an exception (throwable) at the WARN level.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.waarp.common.logging.WaarpLogger

debug, debug, debug, debug, debug, error, error, error, error, error, info, info, info, info, info, isDebugEnabled, isErrorEnabled, isInfoEnabled, isTraceEnabled, isWarnEnabled, junit, setLevel, trace, trace, trace, trace, trace, warn, warn, warn, warn, warn

Constructor Detail

AbstractWaarpLogger

protected AbstractWaarpLogger(String name)

Creates a new instance.

Method Detail

name

public final String name()

Description copied from interface: WaarpLogger

Return the name of this WaarpLogger instance.

Specified by:

name in interface WaarpLogger

Returns:

name of this logger instance

isEnabled

public final boolean isEnabled(WaarpLogLevel level)

Description copied from interface: WaarpLogger

Is the logger instance enabled for the specified level?

Specified by:

isEnabled in interface WaarpLogger

Returns:

True if this Logger is enabled for the specified level, false otherwise.

trace

public final void trace(Throwable t)

Description copied from interface: WaarpLogger

Log an exception (throwable) at the TRACE level.

Specified by:

trace in interface WaarpLogger

Parameters:

t - the exception (throwable) to log

debug

public final void debug(Throwable t)

Description copied from interface: WaarpLogger

Log an exception (throwable) at the DEBUG level.

Specified by:

debug in interface WaarpLogger

Parameters:

t - the exception (throwable) to log

info

public final void info(Throwable t)

Description copied from interface: WaarpLogger

Log an exception (throwable) at the INFO level.

Specified by:

info in interface WaarpLogger

Parameters:

t - the exception (throwable) to log

warn

public final void warn(Throwable t)

Description copied from interface: WaarpLogger

Log an exception (throwable) at the WARN level.

Specified by:

warn in interface WaarpLogger

Parameters:

t - the exception (throwable) to log

error

public final void error(Throwable t)

Description copied from interface: WaarpLogger

Log an exception (throwable) at the ERROR level.

Specified by:

error in interface WaarpLogger

Parameters:

t - the exception (throwable) to log

log

public final void log(WaarpLogLevel level,
                      String msg,
                      Throwable cause)

Description copied from interface: WaarpLogger

Log an exception (throwable) at the specified level with an accompanying message.

Specified by:

log in interface WaarpLogger

msg - the message accompanying the exception

cause - the exception (throwable) to log

log

public final void log(WaarpLogLevel level,
                      Throwable cause)

Description copied from interface: WaarpLogger

Log an exception (throwable) at the specified level.

Specified by:

log in interface WaarpLogger

cause - the exception (throwable) to log

log

public final void log(WaarpLogLevel level,
                      String msg)

Description copied from interface: WaarpLogger

Log a message at the specified level.

Specified by:

log in interface WaarpLogger

msg - the message string to be logged

log

public final void log(WaarpLogLevel level,
                      String format,
                      Object arg)

Description copied from interface: WaarpLogger

Log a message at the specified level according to the specified format and argument.

This form avoids superfluous object creation when the logger is disabled for the specified level.

Specified by:

log in interface WaarpLogger

format - the format string

arg - the argument

log

public final void log(WaarpLogLevel level,
                      String format,
                      Object argA,
                      Object argB)

Description copied from interface: WaarpLogger

Log a message at the specified level according to the specified format and arguments.

This form avoids superfluous object creation when the logger is disabled for the specified level.

Specified by:

log in interface WaarpLogger

format - the format string

argA - the first argument

argB - the second argument

log

public final void log(WaarpLogLevel level,
                      String format,
                      Object... arguments)

Description copied from interface: WaarpLogger

Log a message at the specified level according to the specified format and arguments.

This form avoids superfluous string concatenation when the logger is disabled for the specified level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for the specified level. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

Specified by:

log in interface WaarpLogger

format - the format string

arguments - a list of 3 or more arguments

readResolve

protected final Object readResolve()

simpleClassName

public static String simpleClassName(Object o)

Parameters:

o -

Returns:

the simple Class Name

simpleClassName

public static String simpleClassName(Class<?> clazz)

Parameters:

clazz -

Returns:

the simple Class Name

toString

public String toString()

Overrides:

toString in class Object

getImmediateMethodAndLine

public static String getImmediateMethodAndLine()

To be used in message for logger (rank 2) like logger.warn(code,"message:"+getImmediateMethodAndLine(),null);

Returns:

"ClassAndMethodName(FileName:LineNumber)"

getLoggerMethodAndLine

public static String getLoggerMethodAndLine()

To be used only by Logger (rank 5)

Returns:

"MethodName(FileName:LineNumber)"

getLoggerMethodAndLineCallee

public static String getLoggerMethodAndLineCallee(int deep)

To be used only by Logger (rank 5)

Returns:

"MethodName(FileName:LineNumber)"

getRankMethodAndLine

protected static String getRankMethodAndLine(int rank)

Parameters:

rank - is the current depth of call+1 (immediate = 1+1=2)

Returns:

"ClassAndMethodName(FileName:LineNumber)"