aquality.selenium.core.logging.Logger Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aquality-selenium-core Show documentation

Library with core functions simplifying work with Selenium-controlled applications.

There is a newer version: 4.3.0

Show newest version

package aquality.selenium.core.logging;

import org.apache.log4j.Appender;

/**
 * This class is using for a creating extended log. It implements a Singleton pattern
 */
public final class Logger {

    private static ThreadLocal log4J = ThreadLocal.withInitial(()
            -> org.apache.log4j.Logger.getLogger(String.valueOf(Thread.currentThread().getId())));
    private static ThreadLocal instance = ThreadLocal.withInitial(Logger::new);

    private Logger() {
    }

    /**
     * Gets logger instance
     *
     * @return logger instance
     */
    public static Logger getInstance() {
        return instance.get();
    }

    /**
     * Adds appender
     *
     * @param appender Appender to be added
     * @return logger instance
     */
    public Logger addAppender(Appender appender) {
        log4J.get().addAppender(appender);
        return getInstance();
    }

    /**
     * Removes appender
     *
     * @param appender Appender to be removed
     * @return logger instance
     */
    public Logger removeAppender(Appender appender) {
        log4J.get().removeAppender(appender);
        return getInstance();
    }

    /**
     * Debug log
     *
     * @param message Message
     */
    public void debug(String message) {
        log4J.get().debug(message);
    }

    /**
     * Debug log
     *
     * @param message   Message
     * @param throwable Throwable
     */
    public void debug(String message, Throwable throwable) {
        log4J.get().debug(message, throwable);
    }

    /**
     * Info log
     *
     * @param message Message
     */
    public void info(String message) {
        log4J.get().info(message);
    }

    /**
     * Warning log
     *
     * @param message Message
     */
    public void warn(String message) {
        log4J.get().warn(message);
    }

    /**
     * Error log
     *
     * @param message Message
     */
    public void error(String message) {
        log4J.get().error(message);
    }

    /**
     * Fatal log
     *
     * @param message   Message
     * @param throwable Throwable
     */
    public void fatal(final String message, Throwable throwable) {
        log4J.get().fatal(String.format("%s: %s", message, throwable.toString()));
    }

    /**
     * tries to get localized value by passed key, then applies String.format to fetched value and params
     * then makes record in the log output
     *
     * @param key    key from localized dictionary
     * @param params list of params to format
     */
    public void info(String key, Object... params) {
        log4J.get().info(String.format(key, params));
    }

    /**
     * tries to get localized value by passed key, then applies String.format to fetched value and params
     * then makes record in the log output
     *
     * @param key    key from localized dictionary
     * @param params list of params to format
     */
    public void debug(String key, Object... params) {
        log4J.get().debug(String.format(key, params));
    }
}