org.macroing.cit.logger

Class Logger

java.lang.Object

org.macroing.cit.messaging.Messaging

org.macroing.cit.logger.Logger

public final class Logger
extends org.macroing.cit.messaging.Messaging

A Messaging extension for logging.

To demonstrate some of its use, consider the following example:

 
 Logger logger = Logger.newInstance();
 logger.getMessageChannel().addMessageChannelObserver((messageChannel, message) -> System.out.printf("%s%n", message));
 logger.start();
 logger.info("Hello, World!");
 
 

The above example demonstrates the fact that a Logger is nothing more than an empty shell by default. But it's flexible and allows you to configure it in many different ways. However, most of the time, you're just interested in getting that Logger, so you can log whatever it is that you want to log. You don't want to spend a lot of time configuring it every now and then. It's good, then, that we've taken care of that for you.

The methods getInstance(), getInstance(Class<?>) and getInstance(String) will delegate the responsibility of configuring to the current LoggerConfigurator. But only the first time, when they're created.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

Modifier and Type	Method and Description
void	debug(java.lang.String message) Call this method to log message using Level.DEBUG.
void	debug(java.lang.String message, java.lang.Throwable cause) Call this method to log message using Level.DEBUG.
void	debugf(java.lang.String format, java.lang.Object... objects) Call this method to log String.format(format, objects) using Level.DEBUG.
void	debugf(java.lang.String format, java.lang.Throwable cause, java.lang.Object... objects) Call this method to log String.format(format, objects) using Level.DEBUG.
void	error(java.lang.String message) Call this method to log message using Level.ERROR.
void	error(java.lang.String message, java.lang.Throwable cause) Call this method to log message using Level.ERROR.
void	errorf(java.lang.String format, java.lang.Object... objects) Call this method to log String.format(format, objects) using Level.ERROR.
void	errorf(java.lang.String format, java.lang.Throwable cause, java.lang.Object... objects) Call this method to log String.format(format, objects) using Level.ERROR.
void	fatal(java.lang.String message) Call this method to log message using Level.FATAL.
void	fatal(java.lang.String message, java.lang.Throwable cause) Call this method to log message using Level.FATAL.
void	fatalf(java.lang.String format, java.lang.Object... objects) Call this method to log String.format(format, objects) using Level.FATAL.
void	fatalf(java.lang.String format, java.lang.Throwable cause, java.lang.Object... objects) Call this method to log String.format(format, objects) using Level.FATAL.
static Logger	getInstance() Returns the default Logger instance, with a key of "".
static Logger	getInstance(java.lang.Class<?> clazz) Returns a Logger instance given a key of clazz.getName().
static Logger	getInstance(java.lang.String key) Returns a Logger instance given a key of key.
static java.util.Collection<Logger>	getLoggers() Returns a Collection with all Loggers currently in use.
org.macroing.cit.messaging.MessageChannel	getMessageChannel() Returns the underlying MessageChannel.
void	info(java.lang.String message) Call this method to log message using Level.INFO.
void	info(java.lang.String message, java.lang.Throwable cause) Call this method to log message using Level.INFO.
void	infof(java.lang.String format, java.lang.Object... objects) Call this method to log String.format(format, objects) using Level.INFO.
void	infof(java.lang.String format, java.lang.Throwable cause, java.lang.Object... objects) Call this method to log String.format(format, objects) using Level.INFO.
void	log(java.lang.String message, Level level) Call this method to log message using level.
void	log(java.lang.String message, Level level, java.lang.Throwable cause) Call this method to log message using level.
void	logf(java.lang.String format, Level level, java.lang.Object... objects) Call this method to log String.format(format, objects) using level.
void	logf(java.lang.String format, Level level, java.lang.Throwable cause, java.lang.Object... objects) Call this method to log String.format(format, objects) using level.
static Logger	newInstance() Returns a new empty Logger instance.
protected void	onStart() Overridden to handle start logic.
protected void	onStop() Overridden to handle stop logic.
void	reset() Resets this Logger to its initial empty state.
void	warning(java.lang.String message) Call this method to log message using Level.WARNING.
void	warning(java.lang.String message, java.lang.Throwable cause) Call this method to log message using Level.WARNING.
void	warningf(java.lang.String format, java.lang.Object... objects) Call this method to log String.format(format, objects) using Level.WARNING.
void	warningf(java.lang.String format, java.lang.Throwable cause, java.lang.Object... objects) Call this method to log String.format(format, objects) using Level.WARNING.

Methods inherited from class org.macroing.cit.messaging.Messaging

addMessagingObserver, getMessagingObservers, getName, hasStarted, removeMessagingObserver, setName, start, stop

Methods inherited from class java.lang.Object

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

Method Detail

getMessageChannel

public org.macroing.cit.messaging.MessageChannel getMessageChannel()

Returns the underlying MessageChannel.

Returns:

the underlying MessageChannel

debug

public void debug(java.lang.String message)

Call this method to log message using Level.DEBUG.

If message is null, a NullPointerException will be thrown.

Parameters:

message - the message to log

Throws:

java.lang.NullPointerException - thrown if, and only if, message is null

debug

public void debug(java.lang.String message,
                  java.lang.Throwable cause)

Call this method to log message using Level.DEBUG.

If either message or cause are null, a NullPointerException will be thrown.

Parameters:

message - the message to log

cause - the cause

Throws:

java.lang.NullPointerException - thrown if, and only if, either message or cause are null

debugf

public void debugf(java.lang.String format,
                   java.lang.Object... objects)

Call this method to log String.format(format, objects) using Level.DEBUG.

If either format or objects are null, a NullPointerException will be thrown.

Parameters:

format - the format of the message to log

objects - an array of Objects to supply to the String.format(String, Object...) method

Throws:

java.lang.NullPointerException - thrown if, and only if, either format or objects are null

debugf

public void debugf(java.lang.String format,
                   java.lang.Throwable cause,
                   java.lang.Object... objects)

Call this method to log String.format(format, objects) using Level.DEBUG.

If either format, cause or objects are null, a NullPointerException will be thrown.

Parameters:

format - the format of the message to log

cause - the cause

objects - an array of Objects to supply to the String.format(String, Object...) method

Throws:

java.lang.NullPointerException - thrown if, and only if, either format, cause or objects are null

error

public void error(java.lang.String message)

Call this method to log message using Level.ERROR.

If message is null, a NullPointerException will be thrown.

Parameters:

message - the message to log

Throws:

java.lang.NullPointerException - thrown if, and only if, message is null

error

public void error(java.lang.String message,
                  java.lang.Throwable cause)

Call this method to log message using Level.ERROR.

If either message or cause are null, a NullPointerException will be thrown.

Parameters:

message - the message to log

cause - the cause

Throws:

java.lang.NullPointerException - thrown if, and only if, either message or cause are null

errorf

public void errorf(java.lang.String format,
                   java.lang.Object... objects)

Call this method to log String.format(format, objects) using Level.ERROR.

If either format or objects are null, a NullPointerException will be thrown.

Parameters:

format - the format of the message to log

objects - an array of Objects to supply to the String.format(String, Object...) method

Throws:

java.lang.NullPointerException - thrown if, and only if, either format or objects are null

errorf

public void errorf(java.lang.String format,
                   java.lang.Throwable cause,
                   java.lang.Object... objects)

Call this method to log String.format(format, objects) using Level.ERROR.

If either format, cause or objects are null, a NullPointerException will be thrown.

Parameters:

format - the format of the message to log

cause - the cause

objects - an array of Objects to supply to the String.format(String, Object...) method

Throws:

java.lang.NullPointerException - thrown if, and only if, either format, cause or objects are null

fatal

public void fatal(java.lang.String message)

Call this method to log message using Level.FATAL.

If message is null, a NullPointerException will be thrown.

Parameters:

message - the message to log

Throws:

java.lang.NullPointerException - thrown if, and only if, message is null

fatal

public void fatal(java.lang.String message,
                  java.lang.Throwable cause)

Call this method to log message using Level.FATAL.

If either message or cause are null, a NullPointerException will be thrown.

Parameters:

message - the message to log

cause - the cause

Throws:

java.lang.NullPointerException - thrown if, and only if, either message or cause are null

fatalf

public void fatalf(java.lang.String format,
                   java.lang.Object... objects)

Call this method to log String.format(format, objects) using Level.FATAL.

If either format or objects are null, a NullPointerException will be thrown.

Parameters:

format - the format of the message to log

objects - an array of Objects to supply to the String.format(String, Object...) method

Throws:

java.lang.NullPointerException - thrown if, and only if, either format or objects are null

fatalf

public void fatalf(java.lang.String format,
                   java.lang.Throwable cause,
                   java.lang.Object... objects)

Call this method to log String.format(format, objects) using Level.FATAL.

If either format, cause or objects are null, a NullPointerException will be thrown.

Parameters:

format - the format of the message to log

cause - the cause

objects - an array of Objects to supply to the String.format(String, Object...) method

Throws:

java.lang.NullPointerException - thrown if, and only if, either format, cause or objects are null

info

public void info(java.lang.String message)

Call this method to log message using Level.INFO.

If message is null, a NullPointerException will be thrown.

Parameters:

message - the message to log

Throws:

java.lang.NullPointerException - thrown if, and only if, message is null

info

public void info(java.lang.String message,
                 java.lang.Throwable cause)

Call this method to log message using Level.INFO.

If either message or cause are null, a NullPointerException will be thrown.

Parameters:

message - the message to log

cause - the cause

Throws:

java.lang.NullPointerException - thrown if, and only if, either message or cause are null

infof

public void infof(java.lang.String format,
                  java.lang.Object... objects)

Call this method to log String.format(format, objects) using Level.INFO.

If either format or objects are null, a NullPointerException will be thrown.

Parameters:

format - the format of the message to log

objects - an array of Objects to supply to the String.format(String, Object...) method

Throws:

java.lang.NullPointerException - thrown if, and only if, either format or objects are null

infof

public void infof(java.lang.String format,
                  java.lang.Throwable cause,
                  java.lang.Object... objects)

Call this method to log String.format(format, objects) using Level.INFO.

If either format, cause or objects are null, a NullPointerException will be thrown.

Parameters:

format - the format of the message to log

cause - the cause

objects - an array of Objects to supply to the String.format(String, Object...) method

Throws:

java.lang.NullPointerException - thrown if, and only if, either format, cause or objects are null

onStart

protected void onStart()

Overridden to handle start logic.

Overrides:

onStart in class org.macroing.cit.messaging.Messaging

onStop

protected void onStop()

Overridden to handle stop logic.

Overrides:

onStop in class org.macroing.cit.messaging.Messaging

log

public void log(java.lang.String message,
                Level level)

Call this method to log message using level.

If either message or level are null, a NullPointerException will be thrown.

Parameters:

message - the message to log

level - the Level to log with

Throws:

java.lang.NullPointerException - thrown if, and only if, either message or level are null

log

public void log(java.lang.String message,
                Level level,
                java.lang.Throwable cause)

Call this method to log message using level.

If either message, level or cause are null, a NullPointerException will be thrown.

Parameters:

message - the message to log

level - the Level to log with

cause - the cause

Throws:

java.lang.NullPointerException - thrown if, and only if, either message, level or cause are null

logf

public void logf(java.lang.String format,
                 Level level,
                 java.lang.Object... objects)

Call this method to log String.format(format, objects) using level.

If either format, level or objects are null, a NullPointerException will be thrown.

Parameters:

format - the format of the message to log

level - the Level to log with

objects - an array of Objects to supply to the String.format(String, Object...) method

Throws:

java.lang.NullPointerException - thrown if, and only if, either format, level or objects are null

logf

public void logf(java.lang.String format,
                 Level level,
                 java.lang.Throwable cause,
                 java.lang.Object... objects)

Call this method to log String.format(format, objects) using level.

If either format, level, cause or objects are null, a NullPointerException will be thrown.

Parameters:

format - the format of the message to log

level - the Level to log with

cause - the cause

objects - an array of Objects to supply to the String.format(String, Object...) method

Throws:

java.lang.NullPointerException - thrown if, and only if, either format, level, cause or objects are null

reset

public void reset()

Resets this Logger to its initial empty state.

If you call this method, you may have to call LoggerConfigurator.configure(logger)

warning

public void warning(java.lang.String message)

Call this method to log message using Level.WARNING.

If message is null, a NullPointerException will be thrown.

Parameters:

message - the message to log

Throws:

java.lang.NullPointerException - thrown if, and only if, message is null

warning

public void warning(java.lang.String message,
                    java.lang.Throwable cause)

Call this method to log message using Level.WARNING.

If either message or cause are null, a NullPointerException will be thrown.

Parameters:

message - the message to log

cause - the cause

Throws:

java.lang.NullPointerException - thrown if, and only if, either message or cause are null

warningf

public void warningf(java.lang.String format,
                     java.lang.Object... objects)

Call this method to log String.format(format, objects) using Level.WARNING.

If either format or objects are null, a NullPointerException will be thrown.

Parameters:

format - the format of the message to log

objects - an array of Objects to supply to the String.format(String, Object...) method

Throws:

java.lang.NullPointerException - thrown if, and only if, either format or objects are null

warningf

public void warningf(java.lang.String format,
                     java.lang.Throwable cause,
                     java.lang.Object... objects)

Call this method to log String.format(format, objects) using Level.WARNING.

If either format, cause or objects are null, a NullPointerException will be thrown.

Parameters:

format - the format of the message to log

cause - the cause

objects - an array of Objects to supply to the String.format(String, Object...) method

Throws:

java.lang.NullPointerException - thrown if, and only if, either format, cause or objects are null

getLoggers

public static java.util.Collection<Logger> getLoggers()

Returns a Collection with all Loggers currently in use.

Returns:

a Collection with all Loggers currently in use

getInstance

public static Logger getInstance()

Returns the default Logger instance, with a key of "".

If no Logger with a key of "" did exist prior to this method call, as per the contract of the method getInstance(String), it will be created and configured by the current LoggerConfigurator. In any other case, it will simply just be returned.

Returns:

the default Logger instance, with a key of ""

getInstance

public static Logger getInstance(java.lang.Class<?> clazz)

Returns a Logger instance given a key of clazz.getName().

If clazz is null, a NullPointerException will be thrown.

If no Logger with a key of clazz.getName() did exist prior to this method call, it will be created and configured by the current LoggerConfigurator. In any other case, it will simply just be returned.

Parameters:

clazz - the Class whose name will be the key for the Logger instance

Returns:

the Logger instance given its key clazz.getName()

Throws:

java.lang.NullPointerException - thrown if, and only if, clazz is null

getInstance

public static Logger getInstance(java.lang.String key)

Returns a Logger instance given a key of key.

If key is null, a NullPointerException will be thrown.

If no Logger with a key of key did exist prior to this method call, it will be created and configured by the current LoggerConfigurator. In any other case, it will simply just be returned.

Parameters:

key - the key for the Logger instance

Returns:

the Logger instance given its key key

Throws:

java.lang.NullPointerException - thrown if, and only if, key is null

newInstance

public static Logger newInstance()

Returns a new empty Logger instance.

To configure it, you can do that manually, or let the current LoggerConfigurator do it for you, by calling LoggerConfigurator.configure(logger).

Returns:

a new empty Logger instance