com.varmateo.yawg.logging.LogFactory Maven / Gradle / Ivy

Go to download
/**************************************************************************
 *
 * Copyright (c) 2015-2020 Yawg project contributors.
 *
 **************************************************************************/

package com.varmateo.yawg.logging;

import java.util.logging.Logger;


/**
 * Provides utility methods for creating Log instances.
 */
public final class LogFactory {


    /**
     * No instances of this class are to be created.
     */
    private LogFactory() {

        // Nothing to do.
    }


    /**
     * Creates a Log that will use as output the given
     * Logger instance.
     *
     * If the given logger is null then no logging will take
     * place.
     *
     * @param logger Will be used as output.
     *
     * @return A newly created Log.
     */
    public static Log create(final Logger logger) {

        return new LoggerLog(logger);
    }





    /**
     * Creates a Log assigning it as subsystem name the class
     * name of the given object.
     *
     * @param obj Object whose class name will be used as subsystem name
     * for the logger.
     *
     * @return A newly created Log with an underlying Java
     * Logger using the given object class name as sybsystem
     * name.
     */
    public static Log createFor(final Object obj) {

        final String className  = obj.getClass().getName();
        final Logger javaLogger = Logger.getLogger(className);

        return create(javaLogger);
    }


    /**
     * Creates a Log assigning it as subsystem name the name
     * of the given class.
     *
     * @param klass The class whose name will be used as subsystem name
     * for the logger.
     *
     * @return A newly created Log with an underlying Java
     * Logger using the name of the given class as sybsystem
     * name.
     */
    public static Log createFor(final Class klass) {

        final String className  = klass.getName();
        final Logger javaLogger = Logger.getLogger(className);

        return create(javaLogger);
    }


    /**
     * Creates a Log assigning it as subsystem name the
     * given string.
     *
     * @param name The name that will be used as subsystem name for
     * the logger.
     *
     * @return A newly created Log with an underlying
     * Java Logger using the given name as sybsystem
     * name.
     */
    public static Log createFor(final String name) {

        final Logger javaLogger = Logger.getLogger(name);

        return create(javaLogger);
    }


}