Package berlin.yuna.justlog.logger

Class Logger

java.lang.Object

berlin.yuna.justlog.logger.Logger

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DefaultLogger

public abstract class Logger
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected LoggerConfig	config
protected static ForkJoinPool	executor
protected LogFormatter	formatter
protected LogLevel	level
protected String	name
protected LogWriter	writer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Logger(Class<?> clazz)
protected	Logger(String name)

Method Summary

Modifier and Type	Method	Description
static Logger	add(Logger logger)	Registers a new logger
static Logger	add(Logger logger, boolean replace)	Registers a new logger
Logger	config(Map<String,String> config)	adds or updates config values for the logger, formatter and writer
LoggerConfigLoader	configLoader()
void	debug(Supplier<String> msg)
void	debug(Supplier<String> msg, Supplier<Throwable> t)
static Logger	defaultLogger()
static Logger	defaultLogger(String name)
boolean	equals(Object o)
void	error(Supplier<String> msg)
void	error(Supplier<String> msg, Supplier<Throwable> t)
void	fatal(Supplier<String> msg)
void	fatal(Supplier<String> msg, Supplier<Throwable> t)
LogFormatter	formatter()
Logger	formatter(LogFormatter formatter)	Sets the message formatter
static Set<Logger>	getAll()
static StackTraceElement	getCaller()
static StackTraceElement	getCaller(int traceId)
static Executor	getExecutor()	Initialises new Executor if not present
int	hashCode()
void	info(Supplier<String> msg)
void	info(Supplier<String> msg, Supplier<Throwable> t)
Logger	init()	Method invoked on initialisation
static boolean	isRunning()
LogLevel	level()
Logger	level(LogLevel level)	Sets the log level temporarily until updateConfig() - for permanent updates see config(Map)
void	log(LogLevel level, Supplier<String> msg, Supplier<Throwable> throwable)	logs message using formatter and writer
String	name()
static boolean	remove(Logger logger)	Removes logger from registry
String	toString()
void	trace(Supplier<String> msg)
void	trace(Supplier<String> msg, Supplier<Throwable> t)
Logger	updateConfig()	adds or overwrites config values for the logger, formatter and writer
void	warn(Supplier<String> msg)
void	warn(Supplier<String> msg, Supplier<Throwable> t)
LogWriter	writer()
Logger	writer(LogWriter writer)	Sets the configured message writer

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

writer

protected LogWriter writer

formatter

protected LogFormatter formatter

level

protected LogLevel level

name

protected final String name

config

protected final LoggerConfig config

executor

protected static ForkJoinPool executor

Constructor Detail

Logger

protected Logger(Class<?> clazz)

Logger

protected Logger(String name)

Method Detail

init

public Logger init()

Method invoked on initialisation

Returns:

self

name

public String name()

Returns:

Returns logger name

level

public LogLevel level()

Returns:

Returns log level

level

public Logger level(LogLevel level)

Sets the log level temporarily until updateConfig() - for permanent updates see config(Map)

Parameters:

level - new log level

Returns:

self

formatter

public LogFormatter formatter()

Returns:

Returns configured message formatter

formatter

public Logger formatter(LogFormatter formatter)

Sets the message formatter

Parameters:

formatter - new formatter

Returns:

self

writer

public LogWriter writer()

Returns:

Returns configured message writer

writer

public Logger writer(LogWriter writer)

Sets the configured message writer

Parameters:

writer - new writer

Returns:

self

config

public Logger config(Map<String,String> config)

adds or updates config values for the logger, formatter and writer

Parameters:

config - new configs

Returns:

self

updateConfig

public Logger updateConfig()

adds or overwrites config values for the logger, formatter and writer

Returns:

self

configLoader

public LoggerConfigLoader configLoader()

Returns:

Returns the config loader

trace

public void trace(Supplier<String> msg)

Parameters:

msg - message which will only be loaded if LogLevel.TRACE is active

trace

public void trace(Supplier<String> msg,
                  Supplier<Throwable> t)

Parameters:

msg - message which will only be loaded if LogLevel.TRACE is active

debug

public void debug(Supplier<String> msg)

Parameters:

msg - message which will only be loaded if LogLevel.DEBUG is active

debug

public void debug(Supplier<String> msg,
                  Supplier<Throwable> t)

Parameters:

msg - message which will only be loaded if LogLevel.DEBUG is active

info

public void info(Supplier<String> msg)

Parameters:

msg - message which will only be loaded if LogLevel.INFO is active

info

public void info(Supplier<String> msg,
                 Supplier<Throwable> t)

Parameters:

msg - message which will only be loaded if LogLevel.INFO is active

warn

public void warn(Supplier<String> msg)

Parameters:

msg - message which will only be loaded if LogLevel.WARN is active

warn

public void warn(Supplier<String> msg,
                 Supplier<Throwable> t)

Parameters:

msg - message which will only be loaded if LogLevel.WARN is active

error

public void error(Supplier<String> msg)

Parameters:

msg - message which will only be loaded if LogLevel.ERROR is active

error

public void error(Supplier<String> msg,
                  Supplier<Throwable> t)

Parameters:

msg - message which will only be loaded if LogLevel.ERROR is active

fatal

public void fatal(Supplier<String> msg)

Parameters:

msg - message which will only be loaded if LogLevel.FATAL is active

fatal

public void fatal(Supplier<String> msg,
                  Supplier<Throwable> t)

Parameters:

msg - message which will only be loaded if LogLevel.FATAL is active

log

public void log(LogLevel level,
                Supplier<String> msg,
                Supplier<Throwable> throwable)

logs message using formatter and writer

Parameters:

level - log level to verify if message should be logged

msg - msg message which will only be loaded if level is active

throwable - optional if an exception happened

getAll

public static Set<Logger> getAll()

Returns:

all every registered logger

remove

public static boolean remove(Logger logger)

Removes logger from registry

Parameters:

logger - Logger to be removed from this set, if present

Returns:

Returns: true if this set contained the specified element

add

public static Logger add(Logger logger)

Registers a new logger

Parameters:

logger - new logger to register

Returns:

new logger or previous logger if there is already a registered one

add

public static Logger add(Logger logger,
                         boolean replace)

Registers a new logger

Parameters:

logger - new logger to register

replace - replace old logger if the same logger already exists

Returns:

new logger or previous logger if there is already a registered one and replace is set to false

defaultLogger

public static Logger defaultLogger()

Returns:

default logger

defaultLogger

public static Logger defaultLogger(String name)

Returns:

default logger

getCaller

public static StackTraceElement getCaller()

Returns:

caller id aka StackTraceElement

getCaller

public static StackTraceElement getCaller(int traceId)

Parameters:

traceId - index of caller

Returns:

caller id aka StackTraceElement

getExecutor

public static Executor getExecutor()

Initialises new Executor if not present

Returns:

Executor

isRunning

public static boolean isRunning()

Returns:

true if the executor is used and active threads are running

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object