Package me.github.simonplays15.betterbansystem.core.logging

Enum Class LogLevel

java.lang.Object
java.lang.Enum<LogLevel>
me.github.simonplays15.betterbansystem.core.logging.LogLevel
All Implemented Interfaces:
Serializable, Comparable<LogLevel>, Constable
public enum LogLevel extends Enum<LogLevel>
The LogLevel enum represents different levels of logging. It provides mappings to the standard log levels defined in the java.util.logging.Level class.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DEBUG
    DEBUG represents the debug level for logging purposes.
    ERROR
    The ERROR variable represents the severity level for logging errors.
    FATAL
    The FATAL constant represents the highest level of logging.
    INFO
    The INFO variable is of type LogLevel and represents the logging level for information messages.
    TRACE
    This variable represents the tracing level to be used in the system.
    WARNING
    Represents a warning log level.

  • Method Summary

    Modifier and Type
    Method
    Description
    static LogLevel
    valueOf (String name)
    Returns the enum constant of this class with the specified name.
    static LogLevel[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • INFO

      public static final LogLevel INFO
      The INFO variable is of type LogLevel and represents the logging level for information messages. It has a corresponding mapping to the Level.INFO level defined in the java.util.logging.Level class.

      Example usage: INFO(Level.INFO)

      The INFO variable should be used when logging information messages that are relevant for the normal flow of application execution. Information messages typically provide insights into the current state of the application or important events. These messages are less severe than warning or error messages, but still provide valuable information for debugging and monitoring purposes.

      Note: The INFO variable is part of the LogLevel enum, which provides mappings to various logging levels, including INFO. Other levels in the enum include DEBUG, TRACE, WARNING, FATAL, and ERROR.

      For more information on the different logging levels and how to use them effectively, refer to the java.util.logging package documentation.

    • DEBUG

      public static final LogLevel DEBUG
      DEBUG represents the debug level for logging purposes.

      The DEBUG variable is used to define the debug level for logging. It helps control the amount of information being logged for debugging purposes.

      The value of the DEBUG variable is set using the Level enum class. The Level enum represents the severity levels for logging - from least severe to most severe, the levels are: - TRACE - DEBUG - INFO - WARN - ERROR

      The default value for DEBUG is Level.INFO, which provides informational-level logging.

      Example usage: 

           DEBUG(Level.DEBUG);

    • TRACE

      public static final LogLevel TRACE
      This variable represents the tracing level to be used in the system.

      The TRACE level provides detailed information about the execution flow and state of the system. It can be used for debugging and troubleshooting purposes.

      The possible values for the TRACE level are: - Level.OFF: No tracing information will be logged. - Level.SEVERE: Only severe tracing information will be logged. - Level.WARNING: Only warning and severe tracing information will be logged. - Level.INFO: Information, warning, and severe tracing information will be logged. - Level.CONFIG: Config, information, warning, and severe tracing information will be logged. - Level.FINE: Fine, config, information, warning, and severe tracing information will be logged. - Level.FINER: Finer, fine, config, information, warning, and severe tracing information will be logged. - Level.FINEST: Finest, Finer, fine, config, information, warning, and severe tracing information will be logged. - Level.ALL: All tracing information will be logged.

      The default level is Level.INFO.

      Example usage:

      TRACE(Level.INFO)

    • WARNING

      public static final LogLevel WARNING
      Represents a warning log level.

      The WARNING log level is used to indicate a potential issue or problem that may require attention but does not prevent the system from functioning properly.

      The WARNING log level is mapped to the Level.WARNING log level defined in the Java logging framework.

      See Also:

    • FATAL

      public static final LogLevel FATAL
      The FATAL constant represents the highest level of logging. It maps to the standard severe level defined in the java.util.logging.Level class.

    • ERROR

      public static final LogLevel ERROR
      The ERROR variable represents the severity level for logging errors.

  • Method Details

    • values

      public static LogLevel[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static LogLevel valueOf (String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null