Package lumis.util.log

Interface ILogger

  • All Known Implementing Classes:
    Log4JLoggerWrapper
    @StableMinor(version="17.0",
             sinceVersion="14.2")
public interface ILogger

    The logging interface, that specifies the methods available for logging.

    The six logging levels are (in order):

    1. debug (the least serious)
    2. info
    3. warn
    4. error
    5. fatal (the most serious)

    Performance is often a logging concern. By examining the appropriate property, a component can avoid expensive operations (producing information to be logged).

    For example, 

        if (log.isDebugEnabled()) 
    {
        ... do something expensive ...
        log.debug(theResult);
    }

    Since:
    4.0.0
    Version:
    $Revision: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $
    See Also:
    LoggerFactory

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  ILogger.Level
      The logging levels available in the logging system.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void debug​(java.lang.Object message)
      Log a message with debug log level.
      void debug​(java.lang.Object message, java.lang.Throwable t)
      Log an error with debug log level.
      void debug​(java.util.function.Supplier<?> messageSupplier)
      Log a message with debug log level.
      The message will be generated by the given supplier.
      The supplier will only be invoked if the debug level is enabled.
      void debug​(java.util.function.Supplier<?> messageSupplier, java.lang.Throwable t)
      Log a message with debug log level and the given cause.
      The message will be generated by the given supplier.
      The supplier will only be invoked if the debug level is enabled.
      void error​(java.lang.Object message)
      Log a message with error log level.
      void error​(java.lang.Object message, java.lang.Throwable t)
      Log an error with error log level.
      void error​(java.util.function.Supplier<?> messageSupplier)
      Log a message with error log level.
      The message will be generated by the given supplier.
      The supplier will only be invoked if the error level is enabled.
      void error​(java.util.function.Supplier<?> messageSupplier, java.lang.Throwable t)
      Log a message with error log level and the given cause.
      The message will be generated by the given supplier.
      The supplier will only be invoked if the error level is enabled.
      void fatal​(java.lang.Object message)
      Log a message with fatal log level.
      void fatal​(java.lang.Object message, java.lang.Throwable t)
      Log an error with fatal log level.
      void fatal​(java.util.function.Supplier<?> messageSupplier)
      Log a message with fatal log level.
      The message will be generated by the given supplier.
      The supplier will only be invoked if the fatal level is enabled.
      void fatal​(java.util.function.Supplier<?> messageSupplier, java.lang.Throwable t)
      Log a message with fatal log level and the given cause.
      The message will be generated by the given supplier.
      The supplier will only be invoked if the fatal level is enabled.
      ILogger.Level getLevel()
      Returns the current minimum logging level logged by this instance.
      void info​(java.lang.Object message)
      Log a message with info log level.
      void info​(java.lang.Object message, java.lang.Throwable t)
      Log an error with info log level.
      void info​(java.util.function.Supplier<?> messageSupplier)
      Log a message with info log level.
      The message will be generated by the given supplier.
      The supplier will only be invoked if the info level is enabled.
      void info​(java.util.function.Supplier<?> messageSupplier, java.lang.Throwable t)
      Log a message with info log level and the given cause.
      The message will be generated by the given supplier.
      The supplier will only be invoked if the info level is enabled.
      boolean isDebugEnabled()
      Is debug logging currently enabled?
      boolean isErrorEnabled()
      Is error logging currently enabled?
      boolean isFatalEnabled()
      Is fatal logging currently enabled?
      boolean isInfoEnabled()
      Is info logging currently enabled?
      boolean isWarnEnabled()
      Is warn logging currently enabled?
      void warn​(java.lang.Object message)
      Log a message with warn log level.
      void warn​(java.lang.Object message, java.lang.Throwable t)
      Log an error with warn log level.
      void warn​(java.util.function.Supplier<?> messageSupplier)
      Log a message with warn log level.
      The message will be generated by the given supplier.
      The supplier will only be invoked if the warn level is enabled.
      void warn​(java.util.function.Supplier<?> messageSupplier, java.lang.Throwable t)
      Log a message with warn log level and the given cause.
      The message will be generated by the given supplier.
      The supplier will only be invoked if the warn level is enabled.

    • Method Detail

      • isDebugEnabled

        boolean isDebugEnabled()

        Is debug logging currently enabled?

        Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than debug.

      • isErrorEnabled

        boolean isErrorEnabled()

        Is error logging currently enabled?

        Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than error.

      • isFatalEnabled

        boolean isFatalEnabled()

        Is fatal logging currently enabled?

        Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than fatal.

      • isInfoEnabled

        boolean isInfoEnabled()

        Is info logging currently enabled?

        Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than info.

      • isWarnEnabled

        boolean isWarnEnabled()

        Is warn logging currently enabled?

        Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than warn.

      • debug

        void debug​(java.lang.Object message)

        Log a message with debug log level.

        Parameters:
        message - log this message

      • debug

        void debug​(java.lang.Object message,
           java.lang.Throwable t)

        Log an error with debug log level.

        Parameters:
        message - log this message
        t - log this cause

      • debug

        void debug​(java.util.function.Supplier<?> messageSupplier)
        Log a message with debug log level.
        The message will be generated by the given supplier.
        The supplier will only be invoked if the debug level is enabled.
        Parameters:
        messageSupplier - the message supplier
        Since:
        16.1.0

      • debug

        void debug​(java.util.function.Supplier<?> messageSupplier,
           java.lang.Throwable t)
        Log a message with debug log level and the given cause.
        The message will be generated by the given supplier.
        The supplier will only be invoked if the debug level is enabled.
        Parameters:
        messageSupplier - the message supplier
        t - the cause
        Since:
        16.1.0

      • info

        void info​(java.lang.Object message)

        Log a message with info log level.

        Parameters:
        message - log this message

      • info

        void info​(java.lang.Object message,
          java.lang.Throwable t)

        Log an error with info log level.

        Parameters:
        message - log this message
        t - log this cause

      • info

        void info​(java.util.function.Supplier<?> messageSupplier)
        Log a message with info log level.
        The message will be generated by the given supplier.
        The supplier will only be invoked if the info level is enabled.
        Parameters:
        messageSupplier - the message supplier
        Since:
        16.1.0

      • info

        void info​(java.util.function.Supplier<?> messageSupplier,
          java.lang.Throwable t)
        Log a message with info log level and the given cause.
        The message will be generated by the given supplier.
        The supplier will only be invoked if the info level is enabled.
        Parameters:
        messageSupplier - the message supplier
        t - the cause
        Since:
        16.1.0

      • warn

        void warn​(java.lang.Object message)

        Log a message with warn log level.

        Parameters:
        message - log this message

      • warn

        void warn​(java.lang.Object message,
          java.lang.Throwable t)

        Log an error with warn log level.

        Parameters:
        message - log this message
        t - log this cause

      • warn

        void warn​(java.util.function.Supplier<?> messageSupplier)
        Log a message with warn log level.
        The message will be generated by the given supplier.
        The supplier will only be invoked if the warn level is enabled.
        Parameters:
        messageSupplier - the message supplier
        Since:
        16.1.0

      • warn

        void warn​(java.util.function.Supplier<?> messageSupplier,
          java.lang.Throwable t)
        Log a message with warn log level and the given cause.
        The message will be generated by the given supplier.
        The supplier will only be invoked if the warn level is enabled.
        Parameters:
        messageSupplier - the message supplier
        t - the cause
        Since:
        16.1.0

      • error

        void error​(java.lang.Object message)

        Log a message with error log level.

        Parameters:
        message - log this message

      • error

        void error​(java.lang.Object message,
           java.lang.Throwable t)

        Log an error with error log level.

        Parameters:
        message - log this message
        t - log this cause

      • error

        void error​(java.util.function.Supplier<?> messageSupplier)
        Log a message with error log level.
        The message will be generated by the given supplier.
        The supplier will only be invoked if the error level is enabled.
        Parameters:
        messageSupplier - the message supplier
        Since:
        16.1.0

      • error

        void error​(java.util.function.Supplier<?> messageSupplier,
           java.lang.Throwable t)
        Log a message with error log level and the given cause.
        The message will be generated by the given supplier.
        The supplier will only be invoked if the error level is enabled.
        Parameters:
        messageSupplier - the message supplier
        t - the cause
        Since:
        16.1.0

      • fatal

        void fatal​(java.lang.Object message)

        Log a message with fatal log level.

        Parameters:
        message - log this message

      • fatal

        void fatal​(java.lang.Object message,
           java.lang.Throwable t)

        Log an error with fatal log level.

        Parameters:
        message - log this message
        t - log this cause

      • fatal

        void fatal​(java.util.function.Supplier<?> messageSupplier)
        Log a message with fatal log level.
        The message will be generated by the given supplier.
        The supplier will only be invoked if the fatal level is enabled.
        Parameters:
        messageSupplier - the message supplier
        Since:
        16.1.0

      • fatal

        void fatal​(java.util.function.Supplier<?> messageSupplier,
           java.lang.Throwable t)
        Log a message with fatal log level and the given cause.
        The message will be generated by the given supplier.
        The supplier will only be invoked if the fatal level is enabled.
        Parameters:
        messageSupplier - the message supplier
        t - the cause
        Since:
        16.1.0

      • getLevel

        ILogger.Level getLevel()
        Returns the current minimum logging level logged by this instance.