org.jline.utils.Log Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jline Show documentation
There is a newer version: 3.26.3
/*
 * Copyright (c) 2002-2020, the original author(s).
 *
 * This software is distributable under the BSD license. See the terms of the
 * BSD license in the documentation provided with this software.
 *
 * https://opensource.org/licenses/BSD-3-Clause
 */
package org.jline.utils;

import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.util.function.Supplier;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;

/**
 * Internal logger.
 *
 * @author Jason Dillon
 * @author Guillaume Nodet
 * @since 2.0
 */
public final class Log {
    private static final Logger logger = Logger.getLogger("org.jline");

    public static void trace(final Object... messages) {
        log(Level.FINEST, messages);
    }

    public static void trace(Supplier supplier) {
        log(Level.FINEST, supplier);
    }

    public static void debug(Supplier supplier) {
        log(Level.FINE, supplier);
    }

    public static void debug(final Object... messages) {
        log(Level.FINE, messages);
    }

    public static void info(final Object... messages) {
        log(Level.INFO, messages);
    }

    public static void warn(final Object... messages) {
        log(Level.WARNING, messages);
    }

    public static void error(final Object... messages) {
        log(Level.SEVERE, messages);
    }

    public static boolean isDebugEnabled() {
        return isEnabled(Level.FINE);
    }

    /**
     * Helper to support rendering messages.
     */
    static void render(final PrintStream out, final Object message) {
        if (message != null && message.getClass().isArray()) {
            Object[] array = (Object[]) message;

            out.print("[");
            for (int i = 0; i < array.length; i++) {
                out.print(array[i]);
                if (i + 1 < array.length) {
                    out.print(",");
                }
            }
            out.print("]");
        } else {
            out.print(message);
        }
    }

    static LogRecord createRecord(final Level level, final Object... messages) {
        Throwable cause = null;
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        PrintStream ps = new PrintStream(baos);
        for (int i = 0; i < messages.length; i++) {
            // Special handling for the last message if its a throwable, render its stack on the next line
            if (i + 1 == messages.length && messages[i] instanceof Throwable) {
                cause = (Throwable) messages[i];
            } else {
                render(ps, messages[i]);
            }
        }
        ps.close();
        LogRecord r = new LogRecord(level, baos.toString());
        r.setThrown(cause);
        return r;
    }

    static LogRecord createRecord(final Level level, final Supplier message) {
        return new LogRecord(level, message.get());
    }

    static void log(final Level level, final Supplier message) {
        logr(level, () -> createRecord(level, message));
    }

    static void log(final Level level, final Object... messages) {
        logr(level, () -> createRecord(level, messages));
    }

    static void logr(final Level level, final Supplier record) {
        if (logger.isLoggable(level)) {
            // inform record of the logger-name
            LogRecord tmp = record.get();
            tmp.setLoggerName(logger.getName());
            logger.log(tmp);
        }
    }

    static boolean isEnabled(Level level) {
        return logger.isLoggable(level);
    }
}