dev.jeka.core.api.system

Class JkLog

java.lang.Object

dev.jeka.core.api.system.JkLog

All Implemented Interfaces:

java.io.Serializable

public final class JkLog
extends java.lang.Object
implements java.io.Serializable

Provides static methods for logging events.

Events are simply forwarded to an event consumer which has the responsibility to handle it. A basic handler may simply display events on the console. That is the case for the Jeka tool. By default, logging events turns in a no-op.

This class provides task concept for hierarchical logs. A log event happening during a task will be assigned a nested task level (task can be nested). This feature mekes hierarchical logging possible.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkLog.JkLogDecorator
static class	JkLog.JkLogEvent
static class	JkLog.JkState
static class	JkLog.Style Available style of logging displaying.
static class	JkLog.Type Type of events emitted by logs.
static class	JkLog.Verbosity Levels of logging

Constructor Summary

Constructors

Constructor and Description
JkLog()

Method Summary

Modifier and Type	Method and Description
static void	debug(int maxLength, java.lang.String message, java.lang.Object... params)
static void	debug(java.lang.String message, java.lang.Object... params)
static void	debugEndTask()
static void	debugEndTask(java.lang.String message)
static void	debugStartTask(java.lang.String message, java.lang.Object... params) Logs the start of the current task.
static void	endTask() Same as endTask(String) but using the standard message.
static void	endTask(java.lang.String message) Logs the end of the current task with a specific message.
static void	error(java.lang.String message, java.lang.Object... params)
static int	getCurrentNestedLevel()
static JkLog.JkLogDecorator	getDecorator()
static java.io.PrintStream	getErrPrintStream()
static java.io.PrintStream	getOutPrintStream()
static void	info(java.lang.String message, java.lang.Object... params)
static boolean	isAnimationAccepted()
static boolean	isDebug()
static boolean	isShowTaskDuration()
static boolean	isVerbose()
static void	redirect(java.io.PrintStream out, java.io.PrintStream err)
static void	restoreToInitialState() Let JkLog returns to its initial state, meaning events are not output and System.out/err are back to the state found when this class was loaded.
static void	setAcceptAnimation(boolean acceptAnimation)
static void	setDecorator(JkLog.JkLogDecorator newDecorator) By default, events are not consumed, meaning nothing appends when info(String, Object...) (String), error(String, Object...) (String)}, warn(String, Object...) (String)} or verbose(String, Object...) (String)} are invoked.
static void	setDecorator(JkLog.Style style) This set the default consumer.
static void	setLogOnlyOnStdErr(boolean flag) if true, all log will be printed to stderr instead og stdout.
static void	setShowTaskDuration(boolean showTaskDuration)
static void	setVerbosity(JkLog.Verbosity verbosityArg)
static void	startTask(java.lang.String message, java.lang.Object... params) Logs the start of the current task.
static void	verbose(java.lang.String message, java.lang.Object... params)
static void	verboseEndTask()
static void	verboseStartTask(java.lang.String message, java.lang.Object... params) Logs the start of the current task.
static JkLog.Verbosity	verbosity()
static void	warn(java.lang.String message, java.lang.Object... params)

Methods inherited from class java.lang.Object

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

Constructor Detail

JkLog

public JkLog()

Method Detail

setDecorator

public static void setDecorator(JkLog.JkLogDecorator newDecorator)

By default, events are not consumed, meaning nothing appends when info(String, Object...) (String), error(String, Object...) (String)}, warn(String, Object...) (String)} or verbose(String, Object...) (String)} are invoked. Therefore, users have to set explicitly a consumer using this method or setDecorator(Style) ().

setDecorator

public static void setDecorator(JkLog.Style style)

This set the default consumer. This consumer displays logs in the console in a hierarchical style.

setLogOnlyOnStdErr

public static void setLogOnlyOnStdErr(boolean flag)

if true, all log will be printed to stderr instead og stdout.

Parameters:

flag -

restoreToInitialState

public static void restoreToInitialState()

Let JkLog returns to its initial state, meaning events are not output and System.out/err are back to the state found when this class was loaded.

redirect

public static void redirect(java.io.PrintStream out,
                            java.io.PrintStream err)

setVerbosity

public static void setVerbosity(JkLog.Verbosity verbosityArg)

isAnimationAccepted

public static boolean isAnimationAccepted()

setAcceptAnimation

public static void setAcceptAnimation(boolean acceptAnimation)

isShowTaskDuration

public static boolean isShowTaskDuration()

setShowTaskDuration

public static void setShowTaskDuration(boolean showTaskDuration)

getCurrentNestedLevel

public static int getCurrentNestedLevel()

getOutPrintStream

public static java.io.PrintStream getOutPrintStream()

getErrPrintStream

public static java.io.PrintStream getErrPrintStream()

debug

public static void debug(java.lang.String message,
                         java.lang.Object... params)

debug

public static void debug(int maxLength,
                         java.lang.String message,
                         java.lang.Object... params)

verbose

public static void verbose(java.lang.String message,
                           java.lang.Object... params)

info

public static void info(java.lang.String message,
                        java.lang.Object... params)

warn

public static void warn(java.lang.String message,
                        java.lang.Object... params)

error

public static void error(java.lang.String message,
                         java.lang.Object... params)

startTask

public static void startTask(java.lang.String message,
                             java.lang.Object... params)

Logs the start of the current task. Subsequent logs will be nested in this task log until #endTask is invoked.

verboseStartTask

public static void verboseStartTask(java.lang.String message,
                                    java.lang.Object... params)

Logs the start of the current task. !!! Should be closed by verboseEndTask().

debugStartTask

public static void debugStartTask(java.lang.String message,
                                  java.lang.Object... params)

Logs the start of the current task. !!! Should be closed by verboseEndTask().

endTask

public static void endTask(java.lang.String message)

Logs the end of the current task with a specific message. The specified message is formatted by String#format passing the duration time in milliseconds as argument. So if your message contains '%d', it will be replaced by the duration taken to complete the current task.

endTask

public static void endTask()

Same as endTask(String) but using the standard message.

verboseEndTask

public static void verboseEndTask()

debugEndTask

public static void debugEndTask()

debugEndTask

public static void debugEndTask(java.lang.String message)

isVerbose

public static boolean isVerbose()

isDebug

public static boolean isDebug()

getDecorator

public static JkLog.JkLogDecorator getDecorator()

verbosity

public static JkLog.Verbosity verbosity()