Logger.java

package shts.jp.android.nogifeed.common;

import android.util.Log;

import shts.jp.android.nogifeed.BuildConfig;

/**
 * Android Log wrapper class that can use {@link String#format(String, Object...)} in logging message
 */
public class Logger {

    private static final boolean DEBUG = BuildConfig.BUILD_TYPE == "debug";
    private static final String TAG = Logger.class.getSimpleName();
    private static final String EMPTY = "";

    /**
     * Send a VERBOSE log message.
     * @param tag
     * @param format
     * @param args
     * @return
     */
    public static int v(String tag, String format, Object... args) {
        if (!DEBUG) return 0;
        return Log.v(tag, format(format, args));
    }

    /**
     * Send a VERBOSE log message and log the exception.
     * @param tag
     * @param msg
     * @param e
     * @return
     */
    public static int v(String tag, String msg, Throwable e) {
        if (!DEBUG) return 0;
        return Log.v(tag, msg, e);
    }

    /**
     * Send a VERBOSE log message and log the exception.
     * @param tag
     * @param format
     * @param e
     * @param args
     * @return
     */
    public static int v(String tag, String format, Throwable e, Object... args) {
        if (!DEBUG) return 0;
        return Log.v(tag, format(format, args), e);
    }

    /**
     * Send a DEBUG log message.
     * @param tag
     * @param format
     * @param args
     * @return
     */
    public static int d(String tag, String format, Object... args) {
        if (!DEBUG) return 0;
        return Log.d(tag, format(format, args));
    }

    /**
     * Send a DEBUG log message and log the exception.
     * @param tag
     * @param msg
     * @param e
     * @return
     */
    public static int d(String tag, String msg, Throwable e) {
        if (!DEBUG) return 0;
        return Log.d(tag, msg, e);
    }

    /**
     * Send a DEBUG log message and log the exception.
     * @param tag
     * @param format
     * @param e
     * @param args
     * @return
     */
    public static int d(String tag, String format, Throwable e, Object... args) {
        if (!DEBUG) return 0;
        return Log.d(tag, format(format, args), e);
    }

    /**
     * Send a WARN log message.
     * @param tag
     * @param format
     * @param args
     * @return
     */
    public static int w(String tag, String format, Object... args) {
        if (!DEBUG) return 0;
        return Log.w(tag, format(format, args));
    }

    /**
     * Send a WARN log message and log the exception.
     * @param tag
     * @param msg
     * @param e
     * @return
     */
    public static int w(String tag, String msg, Throwable e) {
        if (!DEBUG) return 0;
        return Log.w(tag, msg, e);
    }

    /**
     * Send a WARN log message and log the exception.
     * @param tag
     * @param format
     * @param e
     * @param args
     * @return
     */
    public static int w(String tag, String format, Throwable e, Object... args) {
        if (!DEBUG) return 0;
        return Log.w(tag, format(format, args), e);
    }

    /**
     * Send a INFO log message.
     * @param tag
     * @param format
     * @param args
     * @return
     */
    public static int i(String tag, String format, Object... args) {
        if (!DEBUG) return 0;
        return Log.i(tag, format(format, args));
    }

    /**
     * Send a INFO log message and log the exception.
     * @param tag
     * @param msg
     * @param e
     * @return
     */
    public static int i(String tag, String msg, Throwable e) {
        if (!DEBUG) return 0;
        return Log.i(tag, msg, e);
    }

    /**
     * Send a INFO log message and log the exception.
     * @param tag
     * @param format
     * @param e
     * @param args
     * @return
     */
    public static int i(String tag, String format, Throwable e, Object... args) {
        if (!DEBUG) return 0;
        return Log.i(tag, format(format, args), e);
    }

    /**
     * Send a ERROR log message.
     * @param tag
     * @param format
     * @param args
     * @return
     */
    public static int e(String tag, String format, Object... args) {
        if (!DEBUG) return 0;
        return Log.e(tag, format(format, args));
    }

    /**
     * Send a ERROR log message and log the exception.
     * @param tag
     * @param msg
     * @param e
     * @return
     */
    public static int e(String tag, String msg, Throwable e) {
        if (!DEBUG) return 0;
        return Log.e(tag, msg, e);
    }

    /**
     * Send a ERROR log message and log the exception.
     * @param tag
     * @param format
     * @param e
     * @param args
     * @return
     */
    public static int e(String tag, String format, Throwable e, Object... args) {
        if (!DEBUG) return 0;
        return Log.e(tag, format(format, args), e);
    }

    private static String format(String format, Object... args) {
        try {
            return String.format(format == null ? EMPTY : format, args);
        } catch (RuntimeException e) {
            Logger.w(TAG, "format error. reason=%s, format=%s", e.getMessage(), format);
            return String.format(EMPTY, format);
        }

    }

}