/*
 * Copyright 2010-2020 Redgate Software Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.flywaydb.core.api.logging;

import org.flywaydb.core.internal.logging.LogCreatorFactory;

Factory for loggers. Custom MigrationResolver, MigrationExecutor, Callback and JavaMigration
implementations should use this to obtain a logger that will work with any logging framework across all environments
(API, Maven, Gradle, CLI, etc).
/**
 * Factory for loggers. Custom MigrationResolver, MigrationExecutor, Callback and JavaMigration
 * implementations should use this to obtain a logger that will work with any logging framework across all environments
 * (API, Maven, Gradle, CLI, etc).
 */
public class LogFactory {
    
Factory for implementation-specific loggers.
/**
     * Factory for implementation-specific loggers.
     */
    private static LogCreator logCreator;

    
The factory for implementation-specific loggers to be used as a fallback when no other suitable loggers were found.
/**
     * The factory for implementation-specific loggers to be used as a fallback when no other suitable loggers were found.
     */
    private static LogCreator fallbackLogCreator;

    
Prevent instantiation.
/**
     * Prevent instantiation.
     */
    private LogFactory() {
        // Do nothing
    }

    
Sets the LogCreator that will be used. This will effectively override Flyway's default LogCreator auto-detection
logic and force Flyway to always use this LogCreator regardless of which log libraries are present on the
classpath.
This is primarily meant for integrating Flyway into environments with their own logging system (like Ant,
Gradle, Maven, ...). This ensures Flyway is a good citizen in those environments and sends its logs through the
expected pipeline.
Params:
logCreator – The factory for implementation-specific loggers./**
     * Sets the LogCreator that will be used. This will effectively override Flyway's default LogCreator auto-detection
     * logic and force Flyway to always use this LogCreator regardless of which log libraries are present on the
     * classpath.
     *
     * <p>This is primarily meant for integrating Flyway into environments with their own logging system (like Ant,
     * Gradle, Maven, ...). This ensures Flyway is a good citizen in those environments and sends its logs through the
     * expected pipeline.</p>
     *
     * @param logCreator The factory for implementation-specific loggers.
     */
    public static void setLogCreator(LogCreator logCreator) {
        LogFactory.logCreator = logCreator;
    }

    
Sets the fallback LogCreator. This LogCreator will be used as a fallback solution when the default LogCreator
auto-detection logic fails to detect a suitable LogCreator based on the log libraries present on the classpath.
Params:
fallbackLogCreator – The factory for implementation-specific loggers to be used as a fallback when no other
                          suitable loggers were found./**
     * Sets the fallback LogCreator. This LogCreator will be used as a fallback solution when the default LogCreator
     * auto-detection logic fails to detect a suitable LogCreator based on the log libraries present on the classpath.
     *
     * @param fallbackLogCreator The factory for implementation-specific loggers to be used as a fallback when no other
     *                           suitable loggers were found.
     */
    public static void setFallbackLogCreator(LogCreator fallbackLogCreator) {
        LogFactory.fallbackLogCreator = fallbackLogCreator;
    }

    
Retrieves the matching logger for this class.
Params:
clazz – The class to get the logger for.
Returns:
The logger./**
     * Retrieves the matching logger for this class.
     *
     * @param clazz The class to get the logger for.
     * @return The logger.
     */
    public static Log getLog(Class<?> clazz) {
        if (logCreator == null) {
            logCreator = LogCreatorFactory.getLogCreator(LogFactory.class.getClassLoader(), fallbackLogCreator);
        }

        return logCreator.createLogger(clazz);
    }
}