org.jcoderz.commons.tracing
Class Slf4jTracer

java.lang.Object
  org.jcoderz.commons.tracing.Slf4jTracer

All Implemented Interfaces:

Tracer

public class Slf4jTracer
extends Object
implements Tracer

A Tracer implementation that used Logger as tracing sink. See Logger.entering(String, String) for an example of the format and semantic used. TODO: Need Marker for classname & methodname? How?

Author:

Andreas Mandel

Nested Class Summary

Nested classes/interfaces inherited from interface org.jcoderz.commons.tracing.Tracer

Tracer.TracingToken

Method Summary

Tracer.TracingToken	entering(String className, String methodName) Delegates to {@link Logger#trace(org.slf4j.Marker, String).
Tracer.TracingToken	entering(String className, String methodName, Object argument) Delegates to Logger.trace(String, Object).
Tracer.TracingToken	entering(String className, String methodName, Object[] arguments) Delegates to Logger#trace(String, String, Object).
void	exiting(Tracer.TracingToken token) Delegates to Logger.trace(String, Object) the message string used is "RETURN".
void	exiting(Tracer.TracingToken token, Object result) Delegates to Logger.trace(String, Object).
String	getClassName() Returns the Name of the class where this tracer belongs to.
static Slf4jTracer	getTracer(String className) Factory for a tracer for classes with the given name.
boolean	isTracing() Returns true, if the level of the underlying slf4j logger has trace enabled.
boolean	isTracingArguments() Returns always true.
void	throwing(Tracer.TracingToken token, Throwable thrown) Delegates to Logger#throwing(String, String, Throwable).

Methods inherited from class java.lang.Object

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

Method Detail

getTracer

public static Slf4jTracer getTracer(String className)

Factory for a tracer for classes with the given name.

Parameters:

className - the name of the class that uses this tracer.

Returns:

a tracer for the given class that dumps trace output to java logging.

isTracing

public boolean isTracing()

Returns true, if the level of the underlying slf4j logger has trace enabled.

Specified by:

isTracing in interface Tracer

See Also:

Logger.isTraceEnabled()

isTracingArguments

public boolean isTracingArguments()

Returns always true.

Specified by:

isTracingArguments in interface Tracer

Returns:

true, if the tracer is evaluating the contents of the arguments.

See Also:

Tracer.isTracingArguments()

getClassName

public String getClassName()

Returns the Name of the class where this tracer belongs to.

Returns:

the Name of the class where this tracer belongs to.

entering

public Tracer.TracingToken entering(String className,
                                    String methodName)

Delegates to {@link Logger#trace(org.slf4j.Marker, String). The className is expected to be the same as the tracer name and is silently ignored.

Specified by:

entering in interface Tracer

Parameters:

className - name of the class

methodName - name of the method entered.

Returns:

a token, holding the context for the followup exiting / throwing call.

See Also:

Tracer.entering(java.lang.String, java.lang.String)

entering

public Tracer.TracingToken entering(String className,
                                    String methodName,
                                    Object argument)

Delegates to Logger.trace(String, Object). The className is expected to be the same as the tracer name and is silently ignored.

Specified by:

entering in interface Tracer

See Also:

Tracer.entering(String, String, Object)

entering

public Tracer.TracingToken entering(String className,
                                    String methodName,
                                    Object[] arguments)

Delegates to Logger#trace(String, String, Object). The className is expected to be the same as the tracer name and is silently ignored.

Specified by:

entering in interface Tracer

See Also:

Tracer.entering(String, String, Object[])

exiting

public void exiting(Tracer.TracingToken token)

Delegates to Logger.trace(String, Object) the message string used is "RETURN". If the token is not a Slf4jTracingToken the call is silently ignored.

Specified by:

exiting in interface Tracer

See Also:

Tracer.exiting(TracingToken)

exiting

public void exiting(Tracer.TracingToken token,
                    Object result)

Delegates to Logger.trace(String, Object). If the token is not a Slf4jTracingToken the call is silently ignored.

Specified by:

exiting in interface Tracer

See Also:

Tracer.exiting(TracingToken, java.lang.Object)

throwing

public void throwing(Tracer.TracingToken token,
                     Throwable thrown)

Delegates to Logger#throwing(String, String, Throwable). If the token is not a Slf4jTracingToken the call is silently ignored.

Specified by:

throwing in interface Tracer

See Also:

Tracer.throwing(TracingToken, java.lang.Throwable)