/* Copyright (c) 2011 Free Range Data, LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package com.frdna.loginator;

/**
 * Generic interface for logging application messages.
 */
public interface Logger {

    /**
     * Logs a trace message if trace logging is enabled.
     *
     * @param source
     *     The source of the message.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void trace(Object source, String message, Object... args);

    /**
     * Logs a trace message if trace logging is enabled.
     *
     * @param source
     *     The source class of the message.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void trace(Class<?> source, String message, Object... args);

    /**
     * Logs a debug message if debug logging is enabled.
     *
     * @param source
     *     The source of the message.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void debug(Object source, String message, Object... args);

    /**
     * Logs a debug message if debug logging is enabled.
     *
     * @param source
     *     The source class of the message.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void debug(Class<?> source, String message, Object... args);

    /**
     * Logs an info message if info logging is enabled.
     *
     * @param source
     *     The source of the message.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void info(Object source, String message, Object... args);

    /**
     * Logs an info message if info logging is enabled.
     *
     * @param source
     *     The source class of the message.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void info(Class<?> source, String message, Object... args);

    /**
     * Logs a warn message if warn logging is enabled.
     *
     * @param source
     *     The source of the message.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void warn(Object source, String message, Object... args);

    /**
     * Logs a warn message if warn logging is enabled.
     *
     * @param source
     *     The source class of the message.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void warn(Class<?> source, String message, Object... args);

    /**
     * Logs a warn message if warn logging is enabled.
     *
     * @param source
     *     The source of the message.
     * @param cause
     *     The cause of the message that should be logged.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void warn(Object source, Throwable cause, String message, Object... args);

    /**
     * Logs a warn message if warn logging is enabled.
     *
     * @param source
     *     The source class of the message.
     * @param cause
     *     The cause of the message that should be logged.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void warn(Class<?> source, Throwable cause, String message, Object... args);

    /**
     * Logs an error message if error logging is enabled.
     *
     * @param source
     *     The source of the message.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void error(Object source, String message, Object... args);

    /**
     * Logs an error message if error logging is enabled.
     *
     * @param source
     *     The source class of the message.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void error(Class<?> source, String message, Object... args);

    /**
     * Logs an error message if error logging is enabled.
     *
     * @param source
     *     The source of the message.
     * @param cause
     *     The cause of the message that should be logged.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void error(Object source, Throwable cause, String message, Object... args);

    /**
     * Logs an error message if error logging is enabled.
     *
     * @param source
     *     The source class of the message.
     * @param cause
     *     The cause of the message that should be logged.
     * @param message
     *     The log message.  This message may be formatted.
     * @param args
     *     Optional arguments for the formatted message.
     * @see String#format
     */
    void error(
            Class<?> source, Throwable cause, String message, Object... args);
}
