Package me.wyne.wutils.log

Class Log

java.lang.Object
me.wyne.wutils.log.Log
public final class Log extends Object
Used to log messages and save log files.
Before logging messages make sure to registerLogger(Logger) and registerConfig(LogConfig).
If you want to save log files make sure to registerExecutor(Executor) and registerLogDirectory(File).

  • Constructor Details

    • Log

      public Log()

  • Method Details

    • isActive

      public static boolean isActive()
      Returns:
      Are logger and config registered?

    • registerLogger

      public static void registerLogger(@NotNull @NotNull Logger logger)
      Register Logger to log all messages.
      Parameters:
      logger - Logger to register

    • registerConfig

      public static void registerConfig(@NotNull @NotNull LogConfig config)
      Register LogConfig to control info(String), warn(String) and error(String) logging.
      Parameters:
      config - Config to register

    • registerLogDirectory

      public static void registerLogDirectory(@NotNull @NotNull File directory)
      Register directory to save log files to.
      Parameters:
      directory - Directory to register

    • registerExecutor

      public static void registerExecutor(@NotNull @NotNull Executor executor)
      Register Executor that will write logs to logDirectory.
      Parameters:
      executor - Executor to register

    • info

      public static boolean info(@NotNull @NotNull String message)
      Returns:
      True if logged successfully

    • warn

      public static boolean warn(@NotNull @NotNull String message)
      Returns:
      True if logged successfully

    • error

      public static boolean error(@NotNull @NotNull String message)
      Returns:
      True if logged successfully

    • log

      public static boolean log(@NotNull @NotNull LogMessage logMessage, boolean doLog)
      Log LogMessage.
      Parameters:
      logMessage - LogMessage to log
      doLog - Log or don't log. Useful when using some logging config
      Returns:
      True if logged successfully

    • log

      public static boolean log(@NotNull @NotNull LogMessage logMessage, @NotNull @NotNull String splitRegex, boolean doLog)
      Log LogMessage and split LogMessage by regex.
      Parameters:
      logMessage - LogMessage to log
      splitRegex - Regex to split LogMessage by
      doLog - Log or don't log. Useful when using some logging config
      Returns:
      True if logged successfully