net.kawinski.logging

Class NkTrace

java.lang.Object

net.kawinski.logging.NkTrace

All Implemented Interfaces:

AutoCloseable

public class NkTrace
extends Object
implements AutoCloseable

Provides a closeable resource which logs entry/exit message logs. When created, it increments an indentation level for new logs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FQCN
static org.slf4j.Marker	MARKER_TRACE_ENTRY
static String	MARKER_TRACE_ENTRY_NAME
static org.slf4j.Marker	MARKER_TRACE_EXIT
static String	MARKER_TRACE_EXIT_NAME
static boolean	useDefaultFormatting Set to false if you want to customize format of entry/exit messages

Constructor Summary

Constructors

Constructor and Description
NkTrace(org.slf4j.Logger logger, org.slf4j.event.Level level, String format, Object... formatArgs)
NkTrace(String fqcn, org.slf4j.Logger logger, org.slf4j.event.Level level, String format, Object... formatArgs)

Method Summary

Modifier and Type	Method and Description
void	close()
static NkTrace	debug(org.slf4j.Logger logger)
static NkTrace	debug(org.slf4j.Logger logger, String format, Object... formatArgs)
static NkTrace	info(org.slf4j.Logger logger)
static NkTrace	info(org.slf4j.Logger logger, String format, Object... formatArgs)
<T> T	returning(T result)
<T> T	returning(T result, String format, Object... formatArgs)
void	setExitMsg(Object exitMsg)
void	setExitMsg(String format, Object... formatArgs)
static NkTrace	trace(org.slf4j.Logger logger)
static NkTrace	trace(org.slf4j.Logger logger, String format, Object... formatArgs)

Methods inherited from class java.lang.Object

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

Field Detail

useDefaultFormatting

public static boolean useDefaultFormatting

Set to false if you want to customize format of entry/exit messages

DEFAULT_FQCN

public static final String DEFAULT_FQCN

MARKER_TRACE_ENTRY_NAME

public static final String MARKER_TRACE_ENTRY_NAME

See Also:

Constant Field Values

MARKER_TRACE_EXIT_NAME

public static final String MARKER_TRACE_EXIT_NAME

See Also:

Constant Field Values

MARKER_TRACE_ENTRY

public static final org.slf4j.Marker MARKER_TRACE_ENTRY

MARKER_TRACE_EXIT

public static final org.slf4j.Marker MARKER_TRACE_EXIT

Constructor Detail

NkTrace

public NkTrace(org.slf4j.Logger logger,
               org.slf4j.event.Level level,
               String format,
               Object... formatArgs)

NkTrace

public NkTrace(String fqcn,
               org.slf4j.Logger logger,
               org.slf4j.event.Level level,
               String format,
               Object... formatArgs)

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

setExitMsg

public void setExitMsg(Object exitMsg)

setExitMsg

public void setExitMsg(String format,
                       Object... formatArgs)

returning

public <T> T returning(T result)

returning

public <T> T returning(T result,
                       String format,
                       Object... formatArgs)

trace

public static NkTrace trace(org.slf4j.Logger logger)

trace

public static NkTrace trace(org.slf4j.Logger logger,
                            String format,
                            Object... formatArgs)

debug

public static NkTrace debug(org.slf4j.Logger logger)

debug

public static NkTrace debug(org.slf4j.Logger logger,
                            String format,
                            Object... formatArgs)

info

public static NkTrace info(org.slf4j.Logger logger)

info

public static NkTrace info(org.slf4j.Logger logger,
                           String format,
                           Object... formatArgs)