com.tersesystems.echopraxia.LoggerFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of logger Show documentation
Java Structured Logging API
The newest version!
package com.tersesystems.echopraxia;

import com.tersesystems.echopraxia.api.*;
import com.tersesystems.echopraxia.spi.Caller;
import com.tersesystems.echopraxia.spi.CoreLogger;
import com.tersesystems.echopraxia.spi.CoreLoggerFactory;
import org.jetbrains.annotations.NotNull;

/**
 * The LoggerFactory class. This is used to create the appropriate `Logger`.
 *
 * {@code private static final Logger logger =
 * LoggerFactory.getLogger(); }
 */
public class LoggerFactory {

  /**
   * Creates a logger using the given class name.
   *
   * @param clazz the logger class to use
   * @return the logger.
   */
  @NotNull
  public static Logger getLogger(Class clazz) {
    final CoreLogger core = CoreLoggerFactory.getLogger(Logger.FQCN, clazz);
    return getLogger(core, PresentationFieldBuilder.instance());
  }

  /**
   * Creates a logger using the given class name and explicit field builder.
   *
   * @param clazz the logger class to use
   * @param builder the field builder.
   * @return the logger.
   * @param  the type of field builder.
   */
  @NotNull
  public static  Logger getLogger(@NotNull Class clazz, @NotNull FB builder) {
    CoreLogger coreLogger = LoggerFactory.getLogger(clazz).core();
    return getLogger(coreLogger, builder);
  }

  /**
   * Creates a logger using the given name.
   *
   * @param name the logger name to use
   * @return the logger.
   */
  @NotNull
  public static Logger getLogger(@NotNull String name) {
    final CoreLogger core = CoreLoggerFactory.getLogger(Logger.FQCN, name);
    return getLogger(core, PresentationFieldBuilder.instance());
  }

  /**
   * Creates a logger using the given name and an explicit field builder.
   *
   * @param name the logger name to use
   * @param builder the field builder.
   * @param  the type of field builder.
   * @return the logger.
   */
  @NotNull
  public static  Logger getLogger(@NotNull String name, @NotNull FB builder) {
    CoreLogger coreLogger = LoggerFactory.getLogger(name).core();
    return getLogger(coreLogger, builder);
  }

  /**
   * Creates a logger using the caller's class name.
   *
   * @return the logger.
   */
  @NotNull
  public static Logger getLogger() {
    CoreLogger core = CoreLoggerFactory.getLogger(Logger.FQCN, Caller.resolveClassName());
    return getLogger(core, PresentationFieldBuilder.instance());
  }

  /**
   * Creates a logger from a core logger.
   *
   * @return the logger.
   */
  public static Logger getLogger(CoreLogger core) {
    return getLogger(core, PresentationFieldBuilder.instance());
  }

  /**
   * Creates a logger using the caller's class name and an explicit field builder.
   *
   * @param fieldBuilder the field builder.
   * @return the logger.
   * @param  the type of field builder.
   */
  @NotNull
  public static  Logger getLogger(@NotNull FB fieldBuilder) {
    CoreLogger core = CoreLoggerFactory.getLogger(Logger.FQCN, Caller.resolveClassName());
    return getLogger(core, fieldBuilder);
  }

  /**
   * Creates a logger from a core logger and a field builder.
   *
   * @param core logger
   * @param fieldBuilder the field builder.
   * @return the logger.
   * @param  the type of field builder.
   */
  @NotNull
  public static  Logger getLogger(@NotNull CoreLogger core, @NotNull FB fieldBuilder) {
    return new Logger<>(core, fieldBuilder);
  }
}