com.rafalzajfert.androidlogger.BaseLogger Maven / Gradle / Ivy

Go to download
package com.rafalzajfert.androidlogger;

import android.support.annotation.NonNull;
import android.support.annotation.Nullable;

import java.text.SimpleDateFormat;
import java.util.Date;

import static com.rafalzajfert.androidlogger.Level.DEBUG;
import static com.rafalzajfert.androidlogger.Level.ERROR;
import static com.rafalzajfert.androidlogger.Level.INFO;
import static com.rafalzajfert.androidlogger.Level.VERBOSE;
import static com.rafalzajfert.androidlogger.Level.WARNING;

/**
 * @author Rafal Zajfert
 * @version 1.1.0 (29/04/2015)
 */
@SuppressWarnings("unused")
class BaseLogger {
    /**
     * Space: " "
     */
    public static final String PARAM_SPACE = " ";

    /**
     * New Line: "\n"
     */
    public static final String PARAM_NEW_LINE = "\r\n";

    /**
     * This parameter can be used in tag pattern or in message to log and it will be replaced with simple name of class in which the logger will be called
     */
    public static final String PARAM_CLASS_NAME = "$ClassName";

    /**
     * This parameter can be used in tag pattern or in message to log and it will be replaced with full name of class (with package) in which the logger will be called
     */
    public static final String PARAM_FULL_CLASS_NAME = "$FullClassName";

    /**
     * This parameter can be used in tag pattern or in message to log and it will be replaced with name of method in which the logger will be called
     */
    public static final String PARAM_METHOD_NAME = "$MethodName";

    /**
     * This parameter can be used in tag pattern or in message to log and it will be replaced with name of file in which the logger will be called
     */
    public static final String PARAM_FILE_NAME = "$FileName";

    /**
     * This parameter can be used in tag pattern or in message to log and it will be replaced with line number in which the logger will be called
     */
    public static final String PARAM_LINE_NUMBER = "$LineNumber";

    /**
     * This parameter can be used in tag pattern or in message to log and it will be replaced with level of the message
     */
    public static final String PARAM_LEVEL = "$Level";

    /**
     * This parameter can be used in tag pattern or in message to log and it will be replaced with short version of the level (e.g. D for the {@link Level#DEBUG DEBUG}) of the message
     */
    public static final String PARAM_SHORT_LEVEL = "$ShortLevel";

    /**
     * This parameter can be used in tag pattern or in message to log and it will be replaced with current time
     * @see LoggerConfig#setDatePattern(String)
     * @see LoggerConfig#setDateFormat(SimpleDateFormat)
     */
    public static final String PARAM_TIME = "$CurrentTime";

    /**
     * This parameter can be used in tag pattern or in message to log and it will be replaced with file name and line number.

     * This param allows you to jump to code line via logcat console.


     * Same as: "({@link #PARAM_FILE_NAME}:{@link #PARAM_LINE_NUMBER})"
     */
    public static final String PARAM_CODE_LINE = "(" + PARAM_FILE_NAME + ":" + PARAM_LINE_NUMBER + ")";

    /**
     * Actual configuration for all loggers
     */
    static LoggerConfig baseConfig = new LoggerConfig();

    /**
     * Configuration of all loggers
     */
    public static void setBaseConfig(@NonNull LoggerConfig config) {
        baseConfig = config;
    }

    /**
     * Configuration of all loggers
     */
    @NonNull
    public static LoggerConfig getBaseConfig() {
        return baseConfig;
    }

    protected static void printToAll(Level level, @Nullable Object message, @Nullable Throwable throwable){
        if (baseConfig.isLevelAllowed(level)) {
            for (Logger logger : baseConfig.getLoggers()) {
                logger.print(level, message, throwable);
            }
        }
    }

    protected static String getSimpleClassName() {
        return LoggerUtils.getStackTraceField(LoggerUtils.StackTraceField.SIMPLE_CLASS_NAME);
    }

    protected static String getFullClassName() {
        return LoggerUtils.getStackTraceField(LoggerUtils.StackTraceField.FULL_CLASS_NAME);
    }

    protected static String getFileName() {
        return LoggerUtils.getStackTraceField(LoggerUtils.StackTraceField.FILE_NAME);
    }

    protected static String getMethodName() {
        return LoggerUtils.getStackTraceField(LoggerUtils.StackTraceField.METHOD_NAME);
    }

    protected static String getLineNumber() {
        return LoggerUtils.getStackTraceField(LoggerUtils.StackTraceField.LINE_NUMBER);
    }

    /** returns {@link Level} name*/
    protected static String getLevelName(@NonNull Level level){
        return level.name();
    }

    /** returns first letter of the {@link Level} */
    protected static String getLevelShortName(@NonNull Level level){
        return level.name().substring(0, 1);
    }

    protected static String getTime(){
        return baseConfig.getDateFormat().format(new Date());
    }

    /**
     * Send an {@link Level#INFO INFO} message

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message to send
     */
    public static void info(Object message) {
        printToAll(INFO, message, null);
    }

    /**
     * Send an {@link Level#INFO INFO} message created
     * from multiple part

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message parts to send
     */
    public static void info(Object... message) {
        printToAll(INFO, LoggerUtils.array2String(baseConfig.getSeparator(), message), null);
    }

    /**
     * Send an {@link Level#INFO INFO} log of
     * {@link Throwable}
     */
    public static void info(Throwable th) {
        printToAll(INFO, null, th);
    }

    /**
     * Send an {@link Level#INFO INFO} message with
     * {@link Throwable} log

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message to send
     */
    public static void info(Object message, Throwable th) {
        printToAll(INFO, message, th);
    }

    /**
     * Send an {@link Level#ERROR ERROR} message

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message to send
     */
    public static void error(Object message) {
        printToAll(ERROR, message, null);
    }

    /**
     * Send an {@link Level#ERROR ERROR} message created
     * from multiple part

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message parts to send
     */
    public static void error(Object... message) {
        printToAll(ERROR, LoggerUtils.array2String(baseConfig.getSeparator(), message), null);
    }

    /**
     * Send an {@link Level#ERROR ERROR} log of
     * {@link Throwable}
     */
    public static void error(Throwable th) {
        printToAll(ERROR, null, th);
    }

    /**
     * Send an {@link Level#ERROR ERROR} message with
     * {@link Throwable} log

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message to send
     */
    public static void error(Object message, Throwable th) {
        printToAll(ERROR, message, th);
    }

    /**
     * Send an {@link Level#DEBUG DEBUG} message

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message to send
     */
    public static void debug(Object message) {
        printToAll(DEBUG, message, null);
    }

    /**
     * Send an {@link Level#DEBUG DEBUG} message created
     * from multiple part

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message parts to send
     */
    public static void debug(Object... message) {
        printToAll(DEBUG, LoggerUtils.array2String(baseConfig.getSeparator(), message), null);
    }

    /**
     * Send an {@link Level#DEBUG DEBUG} log of
     * {@link Throwable}
     */
    public static void debug(Throwable th) {
        printToAll(DEBUG, null, th);
    }

    /**
     * Send an {@link Level#DEBUG DEBUG} message with
     * {@link Throwable} log

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message to send
     */
    public static void debug(Object message, Throwable th) {
        printToAll(DEBUG, message, th);
    }

    /**
     * Send an {@link Level#VERBOSE VERBOSE} message

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message to send
     */
    public static void verbose(Object message) {
        printToAll(VERBOSE, message, null);
    }

    /**
     * Send an {@link Level#VERBOSE VRBOSE} message
     * created from multiple part

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message parts to send
     */
    public static void verbose(Object... message) {
        printToAll(VERBOSE, LoggerUtils.array2String(baseConfig.getSeparator(), message), null);
    }

    /**
     * Send an {@link Level#VERBOSE VERBOSE} log
     * of {@link Throwable}
     */
    public static void verbose(Throwable th) {
        printToAll(VERBOSE, null, th);
    }

    /**
     * Send an {@link Level#VERBOSE VERBOSE} message
     * with {@link Throwable} log

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message to send
     */
    public static void verbose(Object message, Throwable th) {
        printToAll(VERBOSE, message, th);
    }

    /**
     * Send an {@link Level#WARNING WARNING} message

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message to send
     */
    public static void warning(Object message) {
        printToAll(WARNING, message, null);
    }

    /**
     * Send an {@link Level#WARNING WARNING} message
     * created from multiple part

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message parts to send
     */
    public static void warning(Object... message) {
        printToAll(WARNING, LoggerUtils.array2String(baseConfig.getSeparator(), message), null);
    }

    /**
     * Send an {@link Level#WARNING WARNING} log
     * of {@link Throwable}
     */
    public static void warning(Throwable th) {
        printToAll(WARNING, null, th);
    }

    /**
     * Send an {@link Level#WARNING WARNING} message
     * with {@link Throwable} log

     * 

     * You can also use auto generated values:

     * {@link Logger#PARAM_CLASS_NAME
     * PARAM_CLASS_NAME}

     * {@link Logger#PARAM_FULL_CLASS_NAME PARAM_FULL_CLASS_NAME}

     * {@link Logger#PARAM_METHOD_NAME PARAM_METHOD_NAME}

     * {@link Logger#PARAM_FILE_NAME PARAM_FILE_NAME}

     * {@link Logger#PARAM_LINE_NUMBER PARAM_LINE_NUMBER}

     * {@link Logger#PARAM_LEVEL PARAM_LEVEL}

     * {@link Logger#PARAM_SHORT_LEVEL PARAM_SHORT_LEVEL}

     * {@link Logger#PARAM_TIME PARAM_TIME}

     * {@link Logger#PARAM_CODE_LINE PARAM_CODE_LINE}
     *
     * @param message message to send
     */
    public static void warning(Object message, Throwable th) {
        printToAll(WARNING, message, th);
    }

    /**
     * Send an {@link Level#DEBUG DEBUG} message with information where this method was called
     */
    public static void trace() {
        debug("at " + Logger.PARAM_FULL_CLASS_NAME + "." + Logger.PARAM_METHOD_NAME + Logger.PARAM_CODE_LINE);
    }
}