Package io.microsphere.logging

Interface Logger

  • All Known Implementing Classes:
    AbstractLogger
    public interface Logger
    Logger interface for logging messages with different severity levels.

    The Logger provides methods to log messages at various levels such as TRACE, DEBUG, INFO, WARN, and ERROR. Each level has corresponding methods to check if the level is enabled (isXxxEnabled()) and to log messages either as simple strings, formatted strings, or with associated exceptions.

    Example Usage

    Basic Usage

    
 if (logger.isInfoEnabled()) {
     logger.info("Application started successfully.");
 }

    Formatted Logging

    
 String user = "JohnDoe";
 int attempts = 3;
 logger.warn("User '{}' exceeded maximum login attempts: {}", user, attempts);

    Logging Exceptions

    
 try {
     // some operation that may fail
 } catch (Exception e) {
     logger.error("An error occurred during processing", e);
 }

    Conditional Logging

    
 if (logger.isDebugEnabled()) {
     logger.debug("Detailed debug information: {}", generateDebugData());
 }
    Since:
    1.0.0
    Author:
    Mercy

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void debug​(java.lang.String message)
      Log a message at the DEBUG level.
      void debug​(java.lang.String format, java.lang.Object... arguments)
      Log a message at the DEBUG level according to the specified format and arguments.
      void debug​(java.lang.String message, java.lang.Throwable t)
      Log an exception (throwable) at the DEBUG level with an accompanying message.
      void error​(java.lang.String message)
      Log a message at the ERROR level.
      void error​(java.lang.String format, java.lang.Object... arguments)
      Log a message at the ERROR level according to the specified format and arguments.
      void error​(java.lang.String message, java.lang.Throwable t)
      Log an exception (throwable) at the ERROR level with an accompanying message.
      java.lang.String getName()
      Return the name of this Logger instance.
      void info​(java.lang.String message)
      Log a message at the INFO level.
      void info​(java.lang.String format, java.lang.Object... arguments)
      Log a message at the INFO level according to the specified format and arguments.
      void info​(java.lang.String message, java.lang.Throwable t)
      Log an exception (throwable) at the INFO level with an accompanying message.
      boolean isDebugEnabled()
      Is the logger instance enabled for the DEBUG level?
      boolean isErrorEnabled()
      Is the logger instance enabled for the ERROR level?
      boolean isInfoEnabled()
      Is the logger instance enabled for the INFO level?
      boolean isTraceEnabled()
      Is the logger instance enabled for the TRACE level?
      boolean isWarnEnabled()
      Is the logger instance enabled for the WARN level?
      void trace​(java.lang.String message)
      Log a message at the TRACE level.
      void trace​(java.lang.String format, java.lang.Object... arguments)
      Log a message at the TRACE level according to the specified format and arguments.
      void trace​(java.lang.String message, java.lang.Throwable t)
      Log an exception (throwable) at the TRACE level with an accompanying message.
      void warn​(java.lang.String message)
      Log a message at the WARN level.
      void warn​(java.lang.String format, java.lang.Object... arguments)
      Log a message at the WARN level according to the specified format and arguments.
      void warn​(java.lang.String message, java.lang.Throwable t)
      Log an exception (throwable) at the WARN level with an accompanying message.

    • Method Detail

      • getName

        java.lang.String getName()
        Return the name of this Logger instance.
        Returns:
        name of this logger instance

      • isTraceEnabled

        boolean isTraceEnabled()
        Is the logger instance enabled for the TRACE level?
        Returns:
        True if this Logger is enabled for the TRACE level, false otherwise.

      • trace

        void trace​(java.lang.String message)
        Log a message at the TRACE level.
        Parameters:
        message - the message string to be logged

      • trace

        void trace​(java.lang.String format,
           java.lang.Object... arguments)
        Log a message at the TRACE level according to the specified format and arguments.

        This form avoids superfluous string concatenation when the logger is disabled for the TRACE level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for TRACE.

        Parameters:
        format - the format string
        arguments - the arguments

      • trace

        void trace​(java.lang.String message,
           java.lang.Throwable t)
        Log an exception (throwable) at the TRACE level with an accompanying message.
        Parameters:
        message - the message accompanying the exception
        t - the exception (throwable) to log

      • isDebugEnabled

        boolean isDebugEnabled()
        Is the logger instance enabled for the DEBUG level?
        Returns:
        True if this Logger is enabled for the DEBUG level, false otherwise.

      • debug

        void debug​(java.lang.String message)
        Log a message at the DEBUG level.
        Parameters:
        message - the message string to be logged

      • debug

        void debug​(java.lang.String format,
           java.lang.Object... arguments)
        Log a message at the DEBUG level according to the specified format and arguments.
        Parameters:
        format - the format string
        arguments - the arguments

      • debug

        void debug​(java.lang.String message,
           java.lang.Throwable t)
        Log an exception (throwable) at the DEBUG level with an accompanying message.
        Parameters:
        message - the message accompanying the exception
        t - the exception (throwable) to log

      • isInfoEnabled

        boolean isInfoEnabled()
        Is the logger instance enabled for the INFO level?
        Returns:
        True if this Logger is enabled for the INFO level, false otherwise.

      • info

        void info​(java.lang.String message)
        Log a message at the INFO level.
        Parameters:
        message - the message string to be logged

      • info

        void info​(java.lang.String format,
          java.lang.Object... arguments)
        Log a message at the INFO level according to the specified format and arguments.
        Parameters:
        format - the format string
        arguments - the arguments

      • info

        void info​(java.lang.String message,
          java.lang.Throwable t)
        Log an exception (throwable) at the INFO level with an accompanying message.
        Parameters:
        message - the message accompanying the exception
        t - the exception (throwable) to log

      • isWarnEnabled

        boolean isWarnEnabled()
        Is the logger instance enabled for the WARN level?
        Returns:
        True if this Logger is enabled for the WARN level, false otherwise.

      • warn

        void warn​(java.lang.String message)
        Log a message at the WARN level.
        Parameters:
        message - the message string to be logged

      • warn

        void warn​(java.lang.String format,
          java.lang.Object... arguments)
        Log a message at the WARN level according to the specified format and arguments.
        Parameters:
        format - the format string
        arguments - the arguments

      • warn

        void warn​(java.lang.String message,
          java.lang.Throwable t)
        Log an exception (throwable) at the WARN level with an accompanying message.
        Parameters:
        message - the message accompanying the exception
        t - the exception (throwable) to log

      • isErrorEnabled

        boolean isErrorEnabled()
        Is the logger instance enabled for the ERROR level?
        Returns:
        True if this Logger is enabled for the ERROR level, false otherwise.

      • error

        void error​(java.lang.String message)
        Log a message at the ERROR level.
        Parameters:
        message - the message string to be logged

      • error

        void error​(java.lang.String format,
           java.lang.Object... arguments)
        Log a message at the ERROR level according to the specified format and arguments.
        Parameters:
        format - the format string
        arguments - the arguments

      • error

        void error​(java.lang.String message,
           java.lang.Throwable t)
        Log an exception (throwable) at the ERROR level with an accompanying message.
        Parameters:
        message - the message accompanying the exception
        t - the exception (throwable) to log