de.carne.boot.logging.Log Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2018-2019 Holger de Carne and contributors, All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package de.carne.boot.logging;

import java.text.MessageFormat;
import java.util.Objects;
import java.util.ResourceBundle;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.eclipse.jdt.annotation.Nullable;

/**
 * Wrapper class for the JDK's {@linkplain Logger} class to make logging easy and efficient.
 */
public final class Log {

	static {
		Logs.initialize();
	}

	private final Logger logger;

	/**
	 * Construct {@linkplain Log}.
	 * 
	 * The created {@linkplain Logger} is named after the calling class' name.
	 */
	public Log() {
		this(Logger.getLogger(getCallerClassName()));
	}

	/**
	 * Construct {@linkplain Log}.
	 * 
	 * The created {@linkplain Logger} is named after the calling class' name.
	 *
	 * @param resourceBundleName The name of the {@linkplain ResourceBundle} to use for log message localization.
	 */
	public Log(String resourceBundleName) {
		this(Logger.getLogger(getCallerClassName(), resourceBundleName));
	}

	/**
	 * Construct {@linkplain Log}.
	 *
	 * @param clazz The {@linkplain Class} to use for the {@linkplain Logger} name.
	 */
	public Log(Class clazz) {
		this(Logger.getLogger(clazz.getName()));
	}

	/**
	 * Construct {@linkplain Log}.
	 *
	 * @param clazz The {@linkplain Class} to use for the {@linkplain Logger} name.
	 * @param resourceBundleName The name of the {@linkplain ResourceBundle} to use for log message localization.
	 */
	public Log(Class clazz, String resourceBundleName) {
		this(Logger.getLogger(clazz.getName(), resourceBundleName));
	}

	private Log(Logger logger) {
		this.logger = logger;
	}

	/**
	 * Get the {@linkplain Logger} represented by this instance.
	 *
	 * @return The {@linkplain Logger} represented by this instance.
	 */
	public Logger logger() {
		return this.logger;
	}

	/**
	 * Check whether a message of the submitted {@linkplain Level} would be logged by this {@linkplain Log}.
	 *
	 * @param level The {@linkplain Level} to check.
	 * @return {@code true} if the submitted {@linkplain Level} is enabled.
	 */
	public boolean isLoggable(Level level) {
		return this.logger.isLoggable(level);
	}

	/**
	 * Log a message with the given severity.
	 *
	 * @param level The {@linkplain Level} of the message.
	 * @param thrown The {@linkplain Throwable} related to the message (may be {@code null}).
	 * @param msg The message to log.
	 * @param parameters The message parameters to log.
	 */
	public void log(Level level, @Nullable Throwable thrown, String msg, Object... parameters) {
		if (this.logger.isLoggable(level)) {
			this.logger.log(level, thrown, () -> MessageFormat.format(msg, parameters));
		}
	}

	/**
	 * Check whether a {@linkplain LogLevel#LEVEL_NOTICE} message of level would be logged by this {@linkplain Log}.
	 *
	 * @return {@code true} if {@linkplain LogLevel#LEVEL_NOTICE} is enabled.
	 */
	public boolean isNoticeLoggable() {
		return isLoggable(LogLevel.LEVEL_NOTICE);
	}

	/**
	 * Log a {@linkplain LogLevel#LEVEL_NOTICE} message.
	 *
	 * @param msg The message to log.
	 * @param parameters The message parameters to log.
	 */
	public void notice(String msg, Object... parameters) {
		log(LogLevel.LEVEL_NOTICE, null, msg, parameters);
	}

	/**
	 * Log a {@linkplain LogLevel#LEVEL_NOTICE} message.
	 *
	 * @param thrown The {@linkplain Throwable} related to the message (may be {@code null}).
	 * @param msg The message to log.
	 * @param parameters The message parameters to log.
	 */
	public void notice(Throwable thrown, String msg, Object... parameters) {
		log(LogLevel.LEVEL_NOTICE, thrown, msg, parameters);
	}

	/**
	 * Check whether a {@linkplain LogLevel#LEVEL_ERROR} message of level would be logged by this {@linkplain Log}.
	 *
	 * @return {@code true} if {@linkplain LogLevel#LEVEL_ERROR} is enabled.
	 */
	public boolean isErrorLoggable() {
		return isLoggable(LogLevel.LEVEL_ERROR);
	}

	/**
	 * Log a {@linkplain LogLevel#LEVEL_ERROR} message.
	 *
	 * @param msg The message to log.
	 * @param parameters The message parameters to log.
	 */
	public void error(String msg, Object... parameters) {
		log(LogLevel.LEVEL_ERROR, null, msg, parameters);
	}

	/**
	 * Log a {@linkplain LogLevel#LEVEL_ERROR} message.
	 *
	 * @param thrown The {@linkplain Throwable} related to the message (may be {@code null}).
	 * @param msg The message to log.
	 * @param parameters The message parameters to log.
	 */
	public void error(Throwable thrown, String msg, Object... parameters) {
		log(LogLevel.LEVEL_ERROR, thrown, msg, parameters);
	}

	/**
	 * Check whether a {@linkplain LogLevel#LEVEL_WARNING} message of level would be logged by this {@linkplain Log}.
	 *
	 * @return {@code true} if {@linkplain LogLevel#LEVEL_WARNING} is enabled.
	 */
	public boolean isWarningLoggable() {
		return isLoggable(LogLevel.LEVEL_WARNING);
	}

	/**
	 * Log a {@linkplain LogLevel#LEVEL_WARNING} message.
	 *
	 * @param msg The message to log.
	 * @param parameters The message parameters to log.
	 */
	public void warning(String msg, Object... parameters) {
		log(LogLevel.LEVEL_WARNING, null, msg, parameters);
	}

	/**
	 * Log a {@linkplain LogLevel#LEVEL_WARNING} message.
	 *
	 * @param thrown The {@linkplain Throwable} related to the message (may be {@code null}).
	 * @param msg The message to log.
	 * @param parameters The message parameters to log.
	 */
	public void warning(Throwable thrown, String msg, Object... parameters) {
		log(LogLevel.LEVEL_WARNING, thrown, msg, parameters);
	}

	/**
	 * Check whether a {@linkplain LogLevel#LEVEL_INFO} message of level would be logged by this {@linkplain Log}.
	 *
	 * @return {@code true} if {@linkplain LogLevel#LEVEL_INFO} is enabled.
	 */
	public boolean isInfoLoggable() {
		return isLoggable(LogLevel.LEVEL_INFO);
	}

	/**
	 * Log a {@linkplain LogLevel#LEVEL_INFO} message.
	 *
	 * @param msg The message to log.
	 * @param parameters The message parameters to log.
	 */
	public void info(String msg, Object... parameters) {
		log(LogLevel.LEVEL_INFO, null, msg, parameters);
	}

	/**
	 * Log a {@linkplain LogLevel#LEVEL_INFO} message.
	 *
	 * @param thrown The {@linkplain Throwable} related to the message (may be {@code null}).
	 * @param msg The message to log.
	 * @param parameters The message parameters to log.
	 */
	public void info(Throwable thrown, String msg, Object... parameters) {
		log(LogLevel.LEVEL_INFO, thrown, msg, parameters);
	}

	/**
	 * Check whether a {@linkplain LogLevel#LEVEL_DEBUG} message of level would be logged by this {@linkplain Log}.
	 *
	 * @return {@code true} if {@linkplain LogLevel#LEVEL_DEBUG} is enabled.
	 */
	public boolean isDebugLoggable() {
		return isLoggable(LogLevel.LEVEL_DEBUG);
	}

	/**
	 * Log a {@linkplain LogLevel#LEVEL_DEBUG} message.
	 *
	 * @param msg The message to log.
	 * @param parameters The message parameters to log.
	 */
	public void debug(String msg, Object... parameters) {
		log(LogLevel.LEVEL_DEBUG, null, msg, parameters);
	}

	/**
	 * Log a {@linkplain LogLevel#LEVEL_DEBUG} message.
	 *
	 * @param thrown The {@linkplain Throwable} related to the message (may be {@code null}).
	 * @param msg The message to log.
	 * @param parameters The message parameters to log.
	 */
	public void debug(Throwable thrown, String msg, Object... parameters) {
		log(LogLevel.LEVEL_DEBUG, thrown, msg, parameters);
	}

	/**
	 * Check whether a {@linkplain LogLevel#LEVEL_TRACE} message of level would be logged by this {@linkplain Log}.
	 *
	 * @return {@code true} if {@linkplain LogLevel#LEVEL_TRACE} is enabled.
	 */
	public boolean isTraceLoggable() {
		return isLoggable(LogLevel.LEVEL_TRACE);
	}

	/**
	 * Log a {@linkplain LogLevel#LEVEL_TRACE} message.
	 *
	 * @param msg The message to log.
	 * @param parameters The message parameters to log.
	 */
	public void trace(String msg, Object... parameters) {
		log(LogLevel.LEVEL_TRACE, null, msg, parameters);
	}

	/**
	 * Log a {@linkplain LogLevel#LEVEL_TRACE} message.
	 *
	 * @param thrown The {@linkplain Throwable} related to the message (may be {@code null}).
	 * @param msg The message to log.
	 * @param parameters The message parameters to log.
	 */
	public void trace(Throwable thrown, String msg, Object... parameters) {
		log(LogLevel.LEVEL_TRACE, thrown, msg, parameters);
	}

	private static String getCallerClassName() {
		int steIndex = 0;
		StackTraceElement[] stes = Thread.currentThread().getStackTrace();
		String myClassName = Log.class.getName();

		while (steIndex < stes.length && !myClassName.equals(stes[steIndex].getClassName())) {
			steIndex++;
		}
		while (steIndex < stes.length && myClassName.equals(stes[steIndex].getClassName())) {
			steIndex++;
		}
		return (steIndex < stes.length ? stes[steIndex].getClassName() : myClassName);
	}

	@Override
	public String toString() {
		return Objects.toString(this.logger.getName());
	}

}