Package com.clumd.projects.java_custom_logging.logging

Class ExtendedLogger

java.lang.Object

java.util.logging.Logger

com.clumd.projects.java_custom_logging.logging.ExtendedLogger

Direct Known Subclasses:

ExtendedSlf4jLogger

public class ExtendedLogger
extends Logger

This class is a very basic extension of the built-in JUL Logger, but with an expansive selection of 'log' methods for all the combinations of operations the average user might require.

There is also support for the 'tags' paradigm for log messages, explained as part of ExtendedLogRecord documentation. Other than the method signatures, basically the rest is a pass-through to the underling Logger, but using the aforementioned Extended Log Record in place of basic Log Record.

Field Summary

Fields inherited from class java.util.logging.Logger

global, GLOBAL_LOGGER_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExtendedLogger(String name)	Protected method to construct a logger for a named subsystem.
protected	ExtendedLogger(String name, Set<String> bakedInTags)	Protected method to construct a logger for a named subsystem.

Method Summary

Modifier and Type	Method	Description
void	log(Level level, String msg)
void	log(Level level, String msg, Object param1)
void	log(Level level, String msg, Object[] params)
void	log(Level level, String tag, String msg)
void	log(Level level, String tag, String msg, Object param1)
void	log(Level level, String tag, String msg, Object[] params)
void	log(Level level, String tag, String msg, Throwable thrown)
void	log(Level level, String tag, String msg, Throwable thrown, Object param1)
void	log(Level level, String tag, String msg, Throwable thrown, Object[] params)
void	log(Level level, String msg, Throwable thrown)
void	log(Level level, String msg, Throwable thrown, Object param1)
void	log(Level level, String msg, Throwable thrown, Object[] params)
void	log(Level level, String tag, Supplier<String> msgSupplier)
void	log(Level level, String tag, Supplier<String> msgSupplier, Object param1)
void	log(Level level, String tag, Supplier<String> msgSupplier, Object[] params)
void	log(Level level, String tag, Supplier<String> msgSupplier, Throwable thrown)
void	log(Level level, String tag, Supplier<String> msgSupplier, Throwable thrown, Object param1)
void	log(Level level, String tag, Supplier<String> msgSupplier, Throwable thrown, Object[] params)
void	log(Level level, Supplier<String> msgSupplier)
void	log(Level level, Supplier<String> msgSupplier, Object param1)
void	log(Level level, Supplier<String> msgSupplier, Object[] params)
void	log(Level level, Supplier<String> msgSupplier, Throwable thrown)
void	log(Level level, Supplier<String> msgSupplier, Throwable thrown, Object param1)
void	log(Level level, Supplier<String> msgSupplier, Throwable thrown, Object[] params)
void	log(Level level, Set<String> tags, String msg)
void	log(Level level, Set<String> tags, String msg, Object param1)
void	log(Level level, Set<String> tags, String msg, Object[] params)
void	log(Level level, Set<String> tags, String msg, Throwable thrown)
void	log(Level level, Set<String> tags, String msg, Throwable thrown, Object param1)
void	log(Level level, Set<String> tags, String msg, Throwable thrown, Object[] params)
void	log(Level level, Set<String> tags, Supplier<String> msgSupplier)
void	log(Level level, Set<String> tags, Supplier<String> msgSupplier, Object param1)
void	log(Level level, Set<String> tags, Supplier<String> msgSupplier, Object[] params)
void	log(Level level, Set<String> tags, Supplier<String> msgSupplier, Throwable thrown)
void	log(Level level, Set<String> tags, Supplier<String> msgSupplier, Throwable thrown, Object param1)
void	log(Level level, Set<String> tags, Supplier<String> msgSupplier, Throwable thrown, Object[] params)
ExtendedLogger	withControllersWhichShouldIgnore(Set<Class<? extends StreamHandler>> controllersIgnoringThisLogger)	Protected method to construct a logger for a named subsystem.

Methods inherited from class java.util.logging.Logger

addHandler, config, config, entering, entering, entering, exiting, exiting, fine, fine, finer, finer, finest, finest, getAnonymousLogger, getAnonymousLogger, getFilter, getGlobal, getHandlers, getLevel, getLogger, getLogger, getName, getParent, getResourceBundle, getResourceBundleName, getUseParentHandlers, info, info, isLoggable, log, log, logp, logp, logp, logp, logp, logp, logrb, logrb, logrb, logrb, logrb, logrb, logrb, logrb, removeHandler, setFilter, setLevel, setParent, setResourceBundle, setUseParentHandlers, severe, severe, throwing, warning, warning

Methods inherited from class java.lang.Object

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

Constructor Details

ExtendedLogger

protected ExtendedLogger(String name)

Protected method to construct a logger for a named subsystem.

The logger will be initially configured with a null Level and with useParentHandlers set to true.

Parameters:

name - A name for the logger. This should be a dot-separated name and should normally be based on the package name or class name of the subsystem, such as java.net or javax.swing. It may be null for anonymous Loggers.

Throws:

MissingResourceException - if the resourceBundleName is non-null and no corresponding resource can be found.

ExtendedLogger

protected ExtendedLogger(String name,
 Set<String> bakedInTags)

Protected method to construct a logger for a named subsystem.

The logger will be initially configured with a null Level and with useParentHandlers set to true.

Parameters:

name - A name for the logger. This should be a dot-separated name and should normally be based on the package name or class name of the subsystem, such as java.net or javax.swing. It may be null for anonymous Loggers.

bakedInTags - A collection of tags which should be applied to every single log message that this Logger will generate. This is mostly for uses such as distributed computing trace IDs or things such as concrete / unchanging environment variables.

Method Details

withControllersWhichShouldIgnore

public ExtendedLogger withControllersWhichShouldIgnore(Set<Class<? extends StreamHandler>> controllersIgnoringThisLogger)

Protected method to construct a logger for a named subsystem.

The logger will be initially configured with a null Level and with useParentHandlers set to true.

Parameters:

controllersIgnoringThisLogger - A collection of Log Controllers (Which must extend a StreamHandler), which in an ideal implementation will IGNORE all log messages from this logger. This is because by default, all log messages will be published to ALL handlers across our JUL implementation. If you had particular logs (idk, say something silly like passwords) which you WANT to log to 'temporary' console-out, but never to a permanent file-out Log Handler, then you could pass FileController classes into this method, and a well-respecting java-common-utils compatible log controller should ignore messages this Logger will pass through.

Returns:

This logger, after having applied these properties. This is to allow for nice method chaining when constructing this logger. Such as LogRoot.createLogger(name, bakedTags).withControllersWhichShouldIgnore(Set.of(FileController.class));

log

public void log(Level level,
 String msg)

Overrides:

log in class Logger

log

public void log(Level level,
 String tag,
 String msg)

log

public void log(Level level,
 Set<String> tags,
 String msg)

log

public void log(Level level,
 Supplier<String> msgSupplier)

Overrides:

log in class Logger

log

public void log(Level level,
 String tag,
 Supplier<String> msgSupplier)

log

public void log(Level level,
 Set<String> tags,
 Supplier<String> msgSupplier)

log

public void log(Level level,
 String msg,
 Object param1)

Overrides:

log in class Logger

log

public void log(Level level,
 String tag,
 String msg,
 Object param1)

log

public void log(Level level,
 Set<String> tags,
 String msg,
 Object param1)

log

public void log(Level level,
 Supplier<String> msgSupplier,
 Object param1)

log

public void log(Level level,
 String tag,
 Supplier<String> msgSupplier,
 Object param1)

log

public void log(Level level,
 Set<String> tags,
 Supplier<String> msgSupplier,
 Object param1)

log

public void log(Level level,
 String msg,
 Object[] params)

Overrides:

log in class Logger

log

public void log(Level level,
 String tag,
 String msg,
 Object[] params)

log

public void log(Level level,
 Set<String> tags,
 String msg,
 Object[] params)

log

public void log(Level level,
 Supplier<String> msgSupplier,
 Object[] params)

log

public void log(Level level,
 String tag,
 Supplier<String> msgSupplier,
 Object[] params)

log

public void log(Level level,
 Set<String> tags,
 Supplier<String> msgSupplier,
 Object[] params)

log

public void log(Level level,
 String msg,
 Throwable thrown)

Overrides:

log in class Logger

log

public void log(Level level,
 String tag,
 String msg,
 Throwable thrown)

log

public void log(Level level,
 Set<String> tags,
 String msg,
 Throwable thrown)

log

public void log(Level level,
 Supplier<String> msgSupplier,
 Throwable thrown)

log

public void log(Level level,
 String tag,
 Supplier<String> msgSupplier,
 Throwable thrown)

log

public void log(Level level,
 Set<String> tags,
 Supplier<String> msgSupplier,
 Throwable thrown)

log

public void log(Level level,
 String msg,
 Throwable thrown,
 Object param1)

log

public void log(Level level,
 String tag,
 String msg,
 Throwable thrown,
 Object param1)

log

public void log(Level level,
 Set<String> tags,
 String msg,
 Throwable thrown,
 Object param1)

log

public void log(Level level,
 Supplier<String> msgSupplier,
 Throwable thrown,
 Object param1)

log

public void log(Level level,
 String tag,
 Supplier<String> msgSupplier,
 Throwable thrown,
 Object param1)

log

public void log(Level level,
 Set<String> tags,
 Supplier<String> msgSupplier,
 Throwable thrown,
 Object param1)

log

public void log(Level level,
 String msg,
 Throwable thrown,
 Object[] params)

log

public void log(Level level,
 String tag,
 String msg,
 Throwable thrown,
 Object[] params)

log

public void log(Level level,
 Set<String> tags,
 String msg,
 Throwable thrown,
 Object[] params)

log

public void log(Level level,
 Supplier<String> msgSupplier,
 Throwable thrown,
 Object[] params)

log

public void log(Level level,
 String tag,
 Supplier<String> msgSupplier,
 Throwable thrown,
 Object[] params)

log

public void log(Level level,
 Set<String> tags,
 Supplier<String> msgSupplier,
 Throwable thrown,
 Object[] params)