org.apache.jena.atlas.logging.FmtLog Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jena-base Show documentation
This module contains non-RDF library code and the common system runtime.
There is a newer version: 5.2.0
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.jena.atlas.logging;

import java.util.IllegalFormatException ;

import org.slf4j.Logger ;
import org.slf4j.LoggerFactory ;

/** Logging with String.format (which can be a expensive)
 *  The formatting operations are not designed specifically for performance, 
 *  but they do delay forming strings for output
 *  until it is know that a log message is actually
 *  required by level setting. 
 *  
 *  An odd effect is order of the arguments - vararg arguments must be last
 *  so the order is Logger/Throwable?/Format/args.
 *  
 *  Also support: Class object instead of logger to help ad hoc usage. 
 */
public class FmtLog {
    /* Log at 'trace' level. */
    public static void trace(Logger log, String fmt, Object...args) {
        if ( log.isTraceEnabled() )
            log.trace(format(fmt, args)) ;
    }

    /* Log at 'trace' level. */
    public static void trace(Logger log, Throwable th, String fmt, Object...args) {
        if ( log.isTraceEnabled() )
            log.trace(format(fmt, args), th) ;
    }

    /* Log at 'trace' level. */
    public static void trace(Class cls, String fmt, Object...args) {
        trace(log(cls), fmt, args) ;
    }

    /* Log at 'trace' level. */
    public static void trace(Class cls, Throwable th, String fmt, Object...args) {
        trace(log(cls), th, fmt, args) ;
    }

    /* Log at 'debug' level */
    public static void debug(Logger log, String fmt, Object...args) {
        if ( log.isDebugEnabled() )
            log.debug(format(fmt, args)) ;
    }

    /* Log at 'debug' level */
    public static void debug(Logger log, Throwable th, String fmt, Object...args) {
        if ( log.isDebugEnabled() )
            log.debug(format(fmt, args), th) ;
    }

    /* Log at 'debug' level */
    public static void debug(Class cls, String fmt, Object...args) {
        debug(log(cls), fmt, args) ;
    }

    /* Log at 'debug' level */
    public static void debug(Class cls, Throwable th, String fmt, Object...args) {
        debug(log(cls), th, fmt, args) ;
    }

    /* Log at 'info' level */
    public static void info(Logger log, String fmt, Object...args) {
        if ( log.isInfoEnabled() )
            log.info(format(fmt, args)) ;
    }

    /* Log at 'info' level */
    public static void info(Logger log, Throwable th, String fmt, Object...args) {
        if ( log.isInfoEnabled() )
            log.info(format(fmt, args), th) ;
    }

    /* Log at 'info' level */
    public static void info(Class cls, String fmt, Object...args) {
        info(log(cls), fmt, args) ;
    }

    /* Log at 'info' level */
    public static void info(Class cls, Throwable th, String fmt, Object...args) {
        info(log(cls), th, fmt, args) ;
    }

    /* Log at 'warn' level */
    public static void warn(Logger log, String fmt, Object...args) {
        if ( log.isWarnEnabled() )
            log.warn(format(fmt, args)) ;
    }

    /* Log at 'warn' level */
    public static void warn(Logger log, Throwable th, String fmt, Object...args) {
        if ( log.isWarnEnabled() )
            log.warn(format(fmt, args), th) ;
    }

    /* Log at 'warn' level */
    public static void warn(Class cls, String fmt, Object...args) {
        warn(log(cls), fmt, args) ;
    }

    /* Log at 'warn' level */
    public static void warn(Class cls, Throwable th, String fmt, Object...args) {
        warn(log(cls), th, fmt, args) ;
    }

   /* Log at 'error' level */
    public static void error(Logger log, String fmt, Object...args) {
        if ( log.isErrorEnabled() )
            log.error(format(fmt, args)) ;
    }

    /* Log at 'error' level */
    public static void error(Logger log, Throwable th, String fmt, Object...args) {
        if ( log.isErrorEnabled() )
            log.error(format(fmt, args), th) ;
    }

    /* Log at 'error' level */
    public static void error(Class cls, String fmt, Object...args) {
        error(log(cls), fmt, args) ;
    }

    /* Log at 'error' level */
    public static void error(Class cls, Throwable th, String fmt, Object...args) {
        error(log(cls), th, fmt, args) ;
    }


    private static String format(String fmt, Object[] args) {
        try {
            return String.format(fmt, args) ;
        } catch (IllegalFormatException ex) {
            // return something, however grotty.
            return fmt+" "+args ;
        }
    }

    private static Logger log(Class cls) {
        return LoggerFactory.getLogger(cls) ;
    }
}