Java example source code file (JCLLoggerAdapter.java)

This example Java source code file (JCLLoggerAdapter.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

formattingtuple, jclloggeradapter, markerignoringbase, object, string, throwable

The JCLLoggerAdapter.java Java example source code

/**
 * Copyright (c) 2004-2011 QOS.ch
 * All rights reserved.
 *
 * 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 org.slf4j.impl;

import org.apache.commons.logging.Log;
import org.slf4j.Logger;
import org.slf4j.helpers.FormattingTuple;
import org.slf4j.helpers.MarkerIgnoringBase;
import org.slf4j.helpers.MessageFormatter;

/**
 * A wrapper over {@link org.apache.commons.logging.Log
 * org.apache.commons.logging.Log} in conformance with the {@link Logger}
 * interface.
 * 
 * @author Ceki Gülcü
 */
public final class JCLLoggerAdapter extends MarkerIgnoringBase {

    private static final long serialVersionUID = 4141593417490482209L;
    final Log log;

    // WARN: JCLLoggerAdapter constructor should have only package access so
    // that only JCLLoggerFactory be able to create one.
    JCLLoggerAdapter(Log log, String name) {
        this.log = log;
        this.name = name;
    }

    /**
     * Delegates to the {@link Log#isTraceEnabled} method of the underlying
     * {@link Log} instance. 
     */
    public boolean isTraceEnabled() {
        return log.isTraceEnabled();
    }

    //

    /**
     * Delegates to the {@link Log#trace(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * @param msg - the message object to be logged
     */
    public void trace(String msg) {
        log.trace(msg);
    }

    /**
     * Delegates to the {@link Log#trace(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level TRACE.
     * </p>
     * 
     * @param format
     *          the format string
     * @param arg
     *          the argument
     */
    public void trace(String format, Object arg) {
        if (log.isTraceEnabled()) {
            FormattingTuple ft = MessageFormatter.format(format, arg);
            log.trace(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#trace(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level TRACE.
     * </p>
     * 
     * @param format
     *          the format string
     * @param arg1
     *          the first argument
     * @param arg2
     *          the second argument
     */
    public void trace(String format, Object arg1, Object arg2) {
        if (log.isTraceEnabled()) {
            FormattingTuple ft = MessageFormatter.format(format, arg1, arg2);
            log.trace(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#trace(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level TRACE.
     * </p>
     * 
     * @param format the format string
     * @param arguments a list of 3 or more arguments
     */
    public void trace(String format, Object... arguments) {
        if (log.isTraceEnabled()) {
            FormattingTuple ft = MessageFormatter.arrayFormat(format, arguments);
            log.trace(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#trace(java.lang.Object, java.lang.Throwable)} method of 
     * the underlying {@link Log} instance.
     * 
     * @param msg
     *          the message accompanying the exception
     * @param t
     *          the exception (throwable) to log
     */
    public void trace(String msg, Throwable t) {
        log.trace(msg, t);
    }

    /**
     * Delegates to the {@link Log#isDebugEnabled} method of the underlying
     * {@link Log} instance. 
     */
    public boolean isDebugEnabled() {
        return log.isDebugEnabled();
    }

    //

    /**
     * Delegates to the {@link Log#debug(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * @param msg - the message object to be logged
     */
    public void debug(String msg) {
        log.debug(msg);
    }

    /**
     * Delegates to the {@link Log#debug(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level DEBUG.
     * </p>
     * 
     * @param format
     *          the format string
     * @param arg
     *          the argument
     */
    public void debug(String format, Object arg) {
        if (log.isDebugEnabled()) {
            FormattingTuple ft = MessageFormatter.format(format, arg);
            log.debug(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#debug(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level DEBUG.
     * </p>
     * 
     * @param format
     *          the format string
     * @param arg1
     *          the first argument
     * @param arg2
     *          the second argument
     */
    public void debug(String format, Object arg1, Object arg2) {
        if (log.isDebugEnabled()) {
            FormattingTuple ft = MessageFormatter.format(format, arg1, arg2);
            log.debug(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#debug(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level DEBUG.
     * </p>
     * 
     * @param format the format string
     * @param arguments a list of 3 or more arguments
     */
    public void debug(String format, Object... arguments) {
        if (log.isDebugEnabled()) {
            FormattingTuple ft = MessageFormatter.arrayFormat(format, arguments);
            log.debug(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#debug(java.lang.Object, java.lang.Throwable)} method of 
     * the underlying {@link Log} instance.
     * 
     * @param msg
     *          the message accompanying the exception
     * @param t
     *          the exception (throwable) to log
     */
    public void debug(String msg, Throwable t) {
        log.debug(msg, t);
    }

    /**
     * Delegates to the {@link Log#isInfoEnabled} method of the underlying
     * {@link Log} instance. 
     */
    public boolean isInfoEnabled() {
        return log.isInfoEnabled();
    }

    /**
     * Delegates to the {@link Log#debug(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * @param msg - the message object to be logged
     */
    public void info(String msg) {
        log.info(msg);
    }

    /**
     * Delegates to the {@link Log#info(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level INFO.
     * </p>
     * 
     * @param format
     *          the format string
     * @param arg
     *          the argument
     */

    public void info(String format, Object arg) {
        if (log.isInfoEnabled()) {
            FormattingTuple ft = MessageFormatter.format(format, arg);
            log.info(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#info(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level INFO.
     * </p>
     * 
     * @param format
     *          the format string
     * @param arg1
     *          the first argument
     * @param arg2
     *          the second argument
     */
    public void info(String format, Object arg1, Object arg2) {
        if (log.isInfoEnabled()) {

            FormattingTuple ft = MessageFormatter.format(format, arg1, arg2);
            log.info(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#info(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level INFO.
     * </p>
     * 
     * @param format the format string
     * @param arguments a list of 3 or more arguments
     */
    public void info(String format, Object... arguments) {
        if (log.isInfoEnabled()) {
            FormattingTuple ft = MessageFormatter.arrayFormat(format, arguments);
            log.info(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#info(java.lang.Object, java.lang.Throwable)} method of 
     * the underlying {@link Log} instance.
     * 
     * @param msg
     *          the message accompanying the exception
     * @param t
     *          the exception (throwable) to log
     */
    public void info(String msg, Throwable t) {
        log.info(msg, t);
    }

    /**
     * Delegates to the {@link Log#isWarnEnabled} method of the underlying
     * {@link Log} instance. 
     */
    public boolean isWarnEnabled() {
        return log.isWarnEnabled();
    }

    /**
     * Delegates to the {@link Log#warn(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * @param msg - the message object to be logged
     */
    public void warn(String msg) {
        log.warn(msg);
    }

    /**
     * Delegates to the {@link Log#warn(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level WARN.
     * </p>
     * 
     * @param format
     *          the format string
     * @param arg
     *          the argument
     */
    public void warn(String format, Object arg) {
        if (log.isWarnEnabled()) {
            FormattingTuple ft = MessageFormatter.format(format, arg);
            log.warn(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#warn(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level WARN.
     * </p>
     * 
     * @param format
     *          the format string
     * @param arg1
     *          the first argument
     * @param arg2
     *          the second argument
     */
    public void warn(String format, Object arg1, Object arg2) {
        if (log.isWarnEnabled()) {
            FormattingTuple ft = MessageFormatter.format(format, arg1, arg2);
            log.warn(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#warn(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level WARN.
     * </p>
     * 
     * @param format the format string
     * @param arguments a list of 3 or more arguments
     */
    public void warn(String format, Object... arguments) {
        if (log.isWarnEnabled()) {
            FormattingTuple ft = MessageFormatter.arrayFormat(format, arguments);
            log.warn(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#warn(java.lang.Object, java.lang.Throwable)} method of 
     * the underlying {@link Log} instance.
     * 
     * @param msg
     *          the message accompanying the exception
     * @param t
     *          the exception (throwable) to log
     */

    public void warn(String msg, Throwable t) {
        log.warn(msg, t);
    }

    /**
     * Delegates to the {@link Log#isErrorEnabled} method of the underlying
     * {@link Log} instance. 
     */
    public boolean isErrorEnabled() {
        return log.isErrorEnabled();
    }

    /**
     * Delegates to the {@link Log#error(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * @param msg - the message object to be logged
     */
    public void error(String msg) {
        log.error(msg);
    }

    /**
     * Delegates to the {@link Log#error(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level ERROR.
     * </p>
     * 
     * @param format
     *          the format string
     * @param arg
     *          the argument
     */
    public void error(String format, Object arg) {
        if (log.isErrorEnabled()) {
            FormattingTuple ft = MessageFormatter.format(format, arg);
            log.error(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#error(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level ERROR.
     * </p>
     * 
     * @param format
     *          the format string
     * @param arg1
     *          the first argument
     * @param arg2
     *          the second argument
     */
    public void error(String format, Object arg1, Object arg2) {
        if (log.isErrorEnabled()) {
            FormattingTuple ft = MessageFormatter.format(format, arg1, arg2);
            log.error(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#error(java.lang.Object)} method of the underlying
     * {@link Log} instance.
     * 
     * <p>
     * However, this form avoids superfluous object creation when the logger is disabled
     * for level ERROR.
     * </p>
     * 
     * @param format the format string
     * @param arguments a list of 3 or more arguments
     */
    public void error(String format, Object... arguments) {
        if (log.isErrorEnabled()) {
            FormattingTuple ft = MessageFormatter.arrayFormat(format, arguments);
            log.error(ft.getMessage(), ft.getThrowable());
        }
    }

    /**
     * Delegates to the {@link Log#error(java.lang.Object, java.lang.Throwable)} method of 
     * the underlying {@link Log} instance.
     * 
     * @param msg
     *          the message accompanying the exception
     * @param t
     *          the exception (throwable) to log
     */

    public void error(String msg, Throwable t) {
        log.error(msg, t);
    }

}