Package com.github.nedelis.jc4j.logging

Class JC4JLogger

java.lang.Object

com.github.nedelis.jc4j.logging.JC4JLogger

public class JC4JLogger
extends Object

Custom logger of the library. This logger is wrapper for the System.out.println() function

See Also:

• JC4JLoggerBuilder
• JC4JLogLevel

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JC4JLogger(String name, Path pathToLogFile, @org.jetbrains.annotations.Range(from=0L, to=7L) int logLevel, JC4JLoggerMessagePattern pattern)

Method Summary

Modifier and Type	Method	Description
void	debug(String msg)
void	debug(String message, Throwable t)
void	disable()	Disables logger
<R> R	doWithoutLogging(@NotNull NoParamsFunction<R> func)	This function allows to do any other function without logging
void	doWithoutLogging(@NotNull Procedure proc)	This procedure allows to do any other procedure without logging
void	enable()	Enables logger
void	error(String msg)
void	error(String msg, @NotNull Throwable t)
void	fatal(String msg)	Prints the given message, stores it in the messages and shuts down the program
void	fatal(String msg, @NotNull Throwable t)	Do the same thing as fatal(String), but also prints the given throwable
void	info(String msg)
void	info(String msg, @NotNull Throwable t)
boolean	isEnabled()	Checks whether the logger is enabled or not
int	logLevel()
String	name()
void	trace(String msg)
void	trace(String msg, Throwable t)
void	warn(String msg)
void	warn(String msg, @NotNull Throwable t)

Methods inherited from class java.lang.Object

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

Constructor Details

JC4JLogger

protected JC4JLogger(String name,
 Path pathToLogFile,
 @org.jetbrains.annotations.Range(from=0L, to=7L) int logLevel,
 JC4JLoggerMessagePattern pattern)

Method Details

trace

public void trace(String msg)

trace

public void trace(String msg,
 Throwable t)

debug

public void debug(String msg)

debug

public void debug(String message,
 Throwable t)

info

public void info(String msg)

info

public void info(String msg,
 @NotNull
 @NotNull Throwable t)

warn

public void warn(String msg)

warn

public void warn(String msg,
 @NotNull
 @NotNull Throwable t)

error

public void error(String msg)

error

public void error(String msg,
 @NotNull
 @NotNull Throwable t)

fatal

public void fatal(String msg)

Prints the given message, stores it in the messages and shuts down the program

Parameters:

msg - message to be printed

fatal

public void fatal(String msg,
 @NotNull
 @NotNull Throwable t)

Do the same thing as fatal(String), but also prints the given throwable

Parameters:

t - throwable to be printed

msg - message to be printed

doWithoutLogging

public <R> R doWithoutLogging(@NotNull
 @NotNull NoParamsFunction<R> func)

This function allows to do any other function without logging

Type Parameters:

R - type of the function's return value

Parameters:

func - returnable function without params

Returns:

result of the given function

doWithoutLogging

public void doWithoutLogging(@NotNull
 @NotNull Procedure proc)

This procedure allows to do any other procedure without logging

Parameters:

proc - procedure that will be executed

disable

public void disable()

Disables logger

enable

public void enable()

Enables logger

isEnabled

public boolean isEnabled()

Checks whether the logger is enabled or not

Returns:

true if the logger is enabled

name

public String name()

Returns:

name of the logger

logLevel

public int logLevel()

Returns:

level of the logger