Package org.xwiki.component.logging

Interface Logger

  • All Known Implementing Classes:
    VoidLogger
    @Deprecated
public interface Logger
    Deprecated.
    starting with 3.1M2 use SLF4J instead
    Logger component, used for logging messages. Classes that want to log should not declare a dependency on this component, but implement the LogEnabled interface. A quick way to enable logging is to extend AbstractLogEnabled.
    Version:
    $Id: 85d5e9db1afdf8ec7c1d5550d37f04cbb6a903ab $

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void debug​(String message)
      Deprecated.
      Log a message with the debug priority.
      void debug​(String message, Object... objects)
      Deprecated.
      Logs the message to the logger with debug priority while expanding the message with the objects passed.
      void debug​(String message, Throwable throwable)
      Deprecated.
      Log a message with the debug priority, also printing the exception that caused this message, along with its stack trace.
      void debug​(String message, Throwable throwable, Object... objects)
      Deprecated.
      Logs the message to the logger with debug priority while expanding the message with the objects passed, also printing the exception that caused this message, along with its stack trace.
      void error​(String message)
      Deprecated.
      Log a message with the error priority.
      void error​(String message, Object... objects)
      Deprecated.
      Logs the message to the logger with error priority while expanding the message with the objects passed.
      void error​(String message, Throwable throwable)
      Deprecated.
      Log a message with the error priority, also printing the exception that caused this message, along with its stack trace.
      void error​(String message, Throwable throwable, Object... objects)
      Deprecated.
      Logs the message to the logger with error priority while expanding the message with the objects passed, also printing the exception that caused this message, along with its stack trace.
      void info​(String message)
      Deprecated.
      Log a message with the info priority.
      void info​(String message, Object... objects)
      Deprecated.
      Logs the message to the logger with info priority while expanding the message with the objects passed.
      void info​(String message, Throwable throwable)
      Deprecated.
      Log a message with the info priority, also printing the exception that caused this message, along with its stack trace.
      void info​(String message, Throwable throwable, Object... objects)
      Deprecated.
      Logs the message to the logger with info priority while expanding the message with the objects passed, also printing the exception that caused this message, along with its stack trace.
      boolean isDebugEnabled()
      Deprecated.
      Check if the debug priority is enabled.
      boolean isErrorEnabled()
      Deprecated.
      Check if the error priority is enabled.
      boolean isInfoEnabled()
      Deprecated.
      Check if the info priority is enabled.
      boolean isWarnEnabled()
      Deprecated.
      Check if the warn priority is enabled.
      void warn​(String message)
      Deprecated.
      Log a message with the warn priority.
      void warn​(String message, Object... objects)
      Deprecated.
      Logs the message to the logger with warn priority while expanding the message with the objects passed.
      void warn​(String message, Throwable throwable)
      Deprecated.
      Log a message with the warn priority, also printing the exception that caused this message, along with its stack trace.
      void warn​(String message, Throwable throwable, Object... objects)
      Deprecated.
      Logs the message to the logger with warn priority while expanding the message with the objects passed, also printing the exception that caused this message, along with its stack trace.

    • Method Detail

      • debug

        void debug​(String message)
        Deprecated.
        Log a message with the debug priority.
        Parameters:
        message - The message to be logged. No further processing of the message is performed.

      • debug

        void debug​(String message,
           Throwable throwable)
        Deprecated.
        Log a message with the debug priority, also printing the exception that caused this message, along with its stack trace.
        Parameters:
        message - The message to be logged. No further processing of the message is performed.
        throwable - The exception associated with the message, for stack trace output.

      • debug

        void debug​(String message,
           Object... objects)
        Deprecated.

        Logs the message to the logger with debug priority while expanding the message with the objects passed. The message uses the MessageFormat syntax.

        Example: log.debug("Doc was created on {0} and was changed {1} times", date, 5); log.debug("There {0,choice,0#are|1#is|1<are} {0,choice,0#no|1#one|1<{0}} file{0,choice,0#s|1#|1<s}", nrFiles);

        The logged message will only be formatted if the message is actually logged.

        Parameters:
        message - The message to be formatted via MessageFormat
        objects - The objects to be filled into the message
        See Also:
        MessageFormat

      • debug

        void debug​(String message,
           Throwable throwable,
           Object... objects)
        Deprecated.

        Logs the message to the logger with debug priority while expanding the message with the objects passed, also printing the exception that caused this message, along with its stack trace. The message uses the MessageFormat syntax.

        Example: log.debug("Unhandled exception while executing the query [{0}]", exception, query);

        The logged message will only be assembled if the message is actually logged.

        Parameters:
        message - The message to be formatted via MessageFormat
        throwable - The exception associated with the message, for stack trace output.
        objects - The objects to be filled into the message
        See Also:
        MessageFormat

      • isDebugEnabled

        boolean isDebugEnabled()
        Deprecated.
        Check if the debug priority is enabled.
        Returns:
        true if messages with debug priority will be logged, false otherwise

      • info

        void info​(String message)
        Deprecated.
        Log a message with the info priority.
        Parameters:
        message - The message to be logged. No further processing of the message is performed.

      • info

        void info​(String message,
          Throwable throwable)
        Deprecated.
        Log a message with the info priority, also printing the exception that caused this message, along with its stack trace.
        Parameters:
        message - The message to be logged. No further processing of the message is performed.
        throwable - The exception associated with the message, for stack trace output.

      • info

        void info​(String message,
          Object... objects)
        Deprecated.

        Logs the message to the logger with info priority while expanding the message with the objects passed. The message uses the MessageFormat syntax.

        Example: log.info("Doc was created on {0} and was changed {1} times", date, 5); log.info("There {0,choice,0#are|1#is|1<are} {0,choice,0#no|1#one|1<{0}} file{0,choice,0#s|1#|1<s}", nrFiles);

        The logged message will only be assembled if the message is actually logged.

        Parameters:
        message - The message to be formatted via MessageFormat
        objects - The objects to be filled into the message
        See Also:
        MessageFormat

      • info

        void info​(String message,
          Throwable throwable,
          Object... objects)
        Deprecated.

        Logs the message to the logger with info priority while expanding the message with the objects passed, also printing the exception that caused this message, along with its stack trace. The message uses the MessageFormat syntax.

        Example: log.info("Unhandled exception while executing the query [{0}]", exception, query);

        The logged message will only be assembled if the message is actually logged.

        Parameters:
        message - The message to be formatted via MessageFormat
        throwable - The exception associated with the message, for stack trace output.
        objects - The objects to be filled into the message
        See Also:
        MessageFormat

      • isInfoEnabled

        boolean isInfoEnabled()
        Deprecated.
        Check if the info priority is enabled.
        Returns:
        true if messages with info priority will be logged, false otherwise

      • warn

        void warn​(String message)
        Deprecated.
        Log a message with the warn priority.
        Parameters:
        message - The message to be logged. No further processing of the message is performed.

      • warn

        void warn​(String message,
          Throwable throwable)
        Deprecated.
        Log a message with the warn priority, also printing the exception that caused this message, along with its stack trace.
        Parameters:
        message - The message to be logged. No further processing of the message is performed.
        throwable - The exception associated with the message, for stack trace output.

      • warn

        void warn​(String message,
          Object... objects)
        Deprecated.

        Logs the message to the logger with warn priority while expanding the message with the objects passed. The message uses the MessageFormat syntax.

        Example: log.warn("Doc was created on {0} and was changed {1} times", date, 5); log.warn("There {0,choice,0#are|1#is|1<are} {0,choice,0#no|1#one|1<{0}} file{0,choice,0#s|1#|1<s}", nrFiles);

        The logged message will only be assembled if the message is actually logged.

        Parameters:
        message - The message to be formatted via MessageFormat
        objects - The objects to be filled into the message
        See Also:
        MessageFormat

      • warn

        void warn​(String message,
          Throwable throwable,
          Object... objects)
        Deprecated.

        Logs the message to the logger with warn priority while expanding the message with the objects passed, also printing the exception that caused this message, along with its stack trace. The message uses the MessageFormat syntax.

        Example: log.warn("Unhandled exception while executing the query [{0}]", exception, query);

        The logged message will only be assembled if the message is actually logged.

        Parameters:
        message - The message to be formatted via MessageFormat
        throwable - The exception associated with the message, for stack trace output.
        objects - The objects to be filled into the message
        See Also:
        MessageFormat

      • isWarnEnabled

        boolean isWarnEnabled()
        Deprecated.
        Check if the warn priority is enabled.
        Returns:
        true if messages with warn priority will be logged, false otherwise

      • error

        void error​(String message)
        Deprecated.
        Log a message with the error priority.
        Parameters:
        message - The message to be logged. No further processing of the message is performed.

      • error

        void error​(String message,
           Throwable throwable)
        Deprecated.
        Log a message with the error priority, also printing the exception that caused this message, along with its stack trace.
        Parameters:
        message - The message to be logged. No further processing of the message is performed.
        throwable - The exception associated with the message, for stack trace output.

      • error

        void error​(String message,
           Object... objects)
        Deprecated.

        Logs the message to the logger with error priority while expanding the message with the objects passed. The message uses the MessageFormat syntax.

        Example: log.error("Doc was created on {0} and was changed {1} times", date, 5); log.error("There {0,choice,0#are|1#is|1<are} {0,choice,0#no|1#one|1<{0}} file{0,choice,0#s|1#|1<s}", nrFiles);

        The logged message will only be assembled if the message is actually logged.

        Parameters:
        message - The message to be formatted via MessageFormat
        objects - The objects to be filled into the message
        See Also:
        MessageFormat

      • error

        void error​(String message,
           Throwable throwable,
           Object... objects)
        Deprecated.

        Logs the message to the logger with error priority while expanding the message with the objects passed, also printing the exception that caused this message, along with its stack trace. The message uses the MessageFormat syntax.

        Example: log.error("Unhandled exception while executing the query [{0}]", exception, query);

        The logged message will only be assembled if the message is actually logged.

        Parameters:
        message - The message to be formatted via MessageFormat
        throwable - The exception associated with the message, for stack trace output.
        objects - The objects to be filled into the message
        See Also:
        MessageFormat

      • isErrorEnabled

        boolean isErrorEnabled()
        Deprecated.
        Check if the error priority is enabled.
        Returns:
        true if messages with error priority will be logged, false otherwise