com.dua3.utility.logging.slf4j.LogEntrySlf4j Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of utility-logging-slf4j Show documentation
Java utilities (logging)
There is a newer version: 14.0.1
Show newest version
package com.dua3.utility.logging.slf4j;

import com.dua3.cabe.annotations.Nullable;
import com.dua3.utility.logging.LogEntry;
import com.dua3.utility.logging.LogLevel;
import org.slf4j.Marker;
import org.slf4j.event.Level;
import org.slf4j.spi.LocationAwareLogger;

import java.time.Instant;
import java.util.function.Supplier;

/**
 * Represents a log entry with information about the log message, time, level, logger, and optional marker and throwable.
 */
public final class LogEntrySlf4j implements LogEntry {
    private final String loggerName;
    private final Instant time;
    private final LogLevel level;
    private final String marker;
    private Supplier messageFormatter;
    private String formattedMessage;
    private final Throwable throwable;

    /**
     * Creates a new instance of LogEntrySlf4j.
     *
     * @param loggerName        the name of the logger
     * @param level             the log level of the log entry
     * @param marker            the marker associated with the log entry (nullable)
     * @param messageFormatter  the supplier used to format the log message
     * @param throwable         the throwable associated with the log entry (nullable)
     */
    public LogEntrySlf4j(String loggerName, Level level, @Nullable Marker marker, Supplier messageFormatter,
                         @Nullable Throwable throwable) {
        this.loggerName = loggerName;
        this.time = Instant.now();
        this.level = translate(level);
        this.marker = marker == null ? "" : marker.getName();
        this.messageFormatter = messageFormatter;
        this.throwable = throwable;
    }

    /**
     * Formats the message using MessageFormatter.basicArrayFormat.
     *
     * @return the formatted message as a string.
     */
    @Override
    public String message() {
        if (messageFormatter != null) {
            formattedMessage = messageFormatter.get();
            messageFormatter = null;
        }
        return formattedMessage;
    }

    @Override
    public String toString() {
        return format("", "");
    }

    /**
     * Returns the logger name.
     *
     * @return the name of the logger.
     */
    @Override
    public String loggerName() {
        return loggerName;
    }

    /**
     * Returns the time when the log entry was created.
     *
     * @return the time when the log entry was created.
     */
    @Override
    public Instant time() {
        return time;
    }

    /**
     * Returns the log level of the log entry.
     *
     * @return the log level of the log entry.
     */
    @Override
    public LogLevel level() {
        return level;
    }

    /**
     * Returns the marker of the log entry.
     *
     * @return the marker of the log entry.
     */
    @Override
    public String marker() {
        return marker;
    }

    /**
     * Returns the throwable associated with this log entry.
     *
     * @return the throwable associated with this log entry.
     */
    @Override
    public Throwable throwable() {
        return throwable;
    }

    /**
     * Translates a given SLF4J Level object to an equivalent LogLevel object.
     *
     * @param level the SLF4J Level object to be translated
     * @return the translated LogLevel object
     */
    private static LogLevel translate(Level level) {
        int levelInt = level.toInt();
        if (levelInt < LocationAwareLogger.DEBUG_INT) {
            return LogLevel.TRACE;
        }
        if (levelInt < LocationAwareLogger.INFO_INT) {
            return LogLevel.DEBUG;
        }
        if (levelInt < LocationAwareLogger.WARN_INT) {
            return LogLevel.INFO;
        }
        if (levelInt < LocationAwareLogger.ERROR_INT) {
            return LogLevel.WARN;
        }
        return LogLevel.ERROR;
    }

}