Package org.apache.log4j.spi

Class SimpleULogger

  • All Implemented Interfaces:
    ULogger
    public final class SimpleULogger
extends java.lang.Object
implements ULogger
    A simple implementation that logs messages of level INFO or higher on the console (System.out).

    The output includes the relative time in milliseconds, thread name, level, logger name, and the message followed by the line separator for the host. In log4j terms it amounts to the "%r [%t] %level %logger - %m%n" pattern. 

     176 [main] INFO examples.Sort - Populating an array of 2 elements in reverse.
 225 [main] INFO examples.SortAlgo - Entered the sort method.
 304 [main] INFO SortAlgo.DUMP - Dump of interger array:
 317 [main] INFO SortAlgo.DUMP - Element [0] = 0
 331 [main] INFO SortAlgo.DUMP - Element [1] = 1
 343 [main] INFO examples.Sort - The next log statement should be an error msg.
 346 [main] ERROR SortAlgo.DUMP - Tried to dump an uninitialized array.
 at org.log4j.examples.SortAlgo.dump(SortAlgo.java:58)
 at org.log4j.examples.Sort.main(Sort.java:64)
 467 [main] INFO  examples.Sort - Exiting main method.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.lang.String ERROR_STR
      ERROR string literal.
      private static java.lang.String INFO_STR
      INFO string literal.
      static java.lang.String LINE_SEPARATOR
      Line separator.
      private java.lang.String loggerName
      Logger name.
      private static long startTime
      Mark the time when this class gets loaded into memory.
      private static java.lang.String WARN_STR
      WARN string literal.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private SimpleULogger​(java.lang.String name)
      Constructor is private to force construction through getLogger.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void debug​(java.lang.Object msg)
      Log a message object with the DEBUG level.
      void debug​(java.lang.Object parameterizedMsg, java.lang.Object param1)
      Log a parameterized message object at the DEBUG level.
      void debug​(java.lang.Object msg, java.lang.Throwable t)
      Log a message object with the DEBUG level including the stack trace of the Throwablet passed as parameter.
      void debug​(java.lang.String parameterizedMsg, java.lang.Object param1, java.lang.Object param2)
      Log a parameterized message object at the DEBUG level.
      void error​(java.lang.Object msg)
      Log a message object with the ERROR level.
      void error​(java.lang.Object parameterizedMsg, java.lang.Object param1)
      Log a parameterized message object at the ERROR level.
      void error​(java.lang.Object msg, java.lang.Throwable t)
      Log a message object with the ERROR level including the stack trace of the Throwablet passed as parameter.
      void error​(java.lang.String parameterizedMsg, java.lang.Object param1, java.lang.Object param2)
      Log a parameterized message object at the ERROR level.
      static SimpleULogger getLogger​(java.lang.String name)
      Creates a new instance.
      void info​(java.lang.Object msg)
      Log a message object with the INFO level.
      void info​(java.lang.Object parameterizedMsg, java.lang.Object param1)
      Log a parameterized message object at the INFO level.
      void info​(java.lang.Object msg, java.lang.Throwable t)
      Log a message object with the INFO level including the stack trace of the Throwablet passed as parameter.
      void info​(java.lang.String parameterizedMsg, java.lang.Object param1, java.lang.Object param2)
      Log a parameterized message object at the INFO level.
      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 isWarnEnabled()
      Is the logger instance enabled for the WARN level?
      private void log​(java.lang.String level, java.lang.String message, java.lang.Throwable t)
      This is our internal implementation for logging regular (non-parameterized) log messages.
      private void parameterizedLog​(java.lang.String level, java.lang.Object parameterizedMsg, java.lang.Object param1, java.lang.Object param2)
      For parameterized messages, first substitute parameters and then log.
      void warn​(java.lang.Object msg)
      Log a message object with the WARN level.
      void warn​(java.lang.Object parameterizedMsg, java.lang.Object param1)
      Log a parameterized message object at the WARN level.
      void warn​(java.lang.Object msg, java.lang.Throwable t)
      Log a message object with the WARN level including the stack trace of the Throwablet passed as parameter.
      void warn​(java.lang.String parameterizedMsg, java.lang.Object param1, java.lang.Object param2)
      Log a parameterized message object at the WARN level.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • loggerName

        private final java.lang.String loggerName
        Logger name.

      • startTime

        private static long startTime
        Mark the time when this class gets loaded into memory.

      • LINE_SEPARATOR

        public static final java.lang.String LINE_SEPARATOR
        Line separator.

      • INFO_STR

        private static final java.lang.String INFO_STR
        INFO string literal.
        See Also:
        Constant Field Values

      • WARN_STR

        private static final java.lang.String WARN_STR
        WARN string literal.
        See Also:
        Constant Field Values

      • ERROR_STR

        private static final java.lang.String ERROR_STR
        ERROR string literal.
        See Also:
        Constant Field Values

    • Constructor Detail

      • SimpleULogger

        private SimpleULogger​(java.lang.String name)
        Constructor is private to force construction through getLogger.
        Parameters:
        name - logger name

    • Method Detail

      • getLogger

        public static SimpleULogger getLogger​(java.lang.String name)
        Creates a new instance.
        Parameters:
        name - logger name
        Returns:
        logger.

      • isDebugEnabled

        public boolean isDebugEnabled()
        Is the logger instance enabled for the DEBUG level?
        Specified by:
        isDebugEnabled in interface ULogger
        Returns:
        true if debug is enabled.

      • debug

        public void debug​(java.lang.Object msg)
        Log a message object with the DEBUG level.
        Specified by:
        debug in interface ULogger
        Parameters:
        msg - - the message object to be logged

      • debug

        public void debug​(java.lang.Object parameterizedMsg,
                  java.lang.Object param1)
        Log a parameterized message object at the DEBUG level.

        This form is useful in avoiding the superflous object creation problem when invoking this method while it is disabled.

        Specified by:
        debug in interface ULogger
        Parameters:
        parameterizedMsg - - the parameterized message object
        param1 - - the parameter

      • debug

        public void debug​(java.lang.String parameterizedMsg,
                  java.lang.Object param1,
                  java.lang.Object param2)
        Log a parameterized message object at the DEBUG level.

        This form is useful in avoiding the superflous object creation problem when invoking this method while it is disabled.

        Specified by:
        debug in interface ULogger
        Parameters:
        parameterizedMsg - - the parameterized message object
        param1 - - the first parameter
        param2 - - the second parameter

      • debug

        public void debug​(java.lang.Object msg,
                  java.lang.Throwable t)
        Log a message object with the DEBUG level including the stack trace of the Throwablet passed as parameter.
        Specified by:
        debug in interface ULogger
        Parameters:
        msg - the message object to log.
        t - the exception to log, including its stack trace.

      • log

        private void log​(java.lang.String level,
                 java.lang.String message,
                 java.lang.Throwable t)
        This is our internal implementation for logging regular (non-parameterized) log messages.
        Parameters:
        level - level
        message - message
        t - throwable

      • parameterizedLog

        private void parameterizedLog​(java.lang.String level,
                              java.lang.Object parameterizedMsg,
                              java.lang.Object param1,
                              java.lang.Object param2)
        For parameterized messages, first substitute parameters and then log.
        Parameters:
        level - level
        parameterizedMsg - message pattern
        param1 - param1
        param2 - param2

      • isInfoEnabled

        public boolean isInfoEnabled()
        Is the logger instance enabled for the INFO level?
        Specified by:
        isInfoEnabled in interface ULogger
        Returns:
        true if debug is enabled.

      • info

        public void info​(java.lang.Object msg)
        Log a message object with the INFO level.
        Specified by:
        info in interface ULogger
        Parameters:
        msg - - the message object to be logged

      • info

        public void info​(java.lang.Object parameterizedMsg,
                 java.lang.Object param1)
        Log a parameterized message object at the INFO level.

        This form is useful in avoiding the superflous object creation problem when invoking this method while it is disabled.

        Specified by:
        info in interface ULogger
        Parameters:
        parameterizedMsg - - the parameterized message object
        param1 - - the parameter

      • info

        public void info​(java.lang.String parameterizedMsg,
                 java.lang.Object param1,
                 java.lang.Object param2)
        Log a parameterized message object at the INFO level.

        This form is useful in avoiding the superflous object creation problem when invoking this method while it is disabled.

        Specified by:
        info in interface ULogger
        Parameters:
        parameterizedMsg - - the parameterized message object
        param1 - - the first parameter
        param2 - - the second parameter

      • info

        public void info​(java.lang.Object msg,
                 java.lang.Throwable t)
        Log a message object with the INFO level including the stack trace of the Throwablet passed as parameter.
        Specified by:
        info in interface ULogger
        Parameters:
        msg - the message object to log.
        t - the exception to log, including its stack trace.

      • isWarnEnabled

        public boolean isWarnEnabled()
        Is the logger instance enabled for the WARN level?
        Specified by:
        isWarnEnabled in interface ULogger
        Returns:
        true if debug is enabled.

      • warn

        public void warn​(java.lang.Object msg)
        Log a message object with the WARN level.
        Specified by:
        warn in interface ULogger
        Parameters:
        msg - - the message object to be logged

      • warn

        public void warn​(java.lang.Object parameterizedMsg,
                 java.lang.Object param1)
        Log a parameterized message object at the WARN level.

        This form is useful in avoiding the superflous object creation problem when invoking this method while it is disabled.

        Specified by:
        warn in interface ULogger
        Parameters:
        parameterizedMsg - - the parameterized message object
        param1 - - the parameter

      • warn

        public void warn​(java.lang.String parameterizedMsg,
                 java.lang.Object param1,
                 java.lang.Object param2)
        Log a parameterized message object at the WARN level.

        This form is useful in avoiding the superflous object creation problem when invoking this method while it is disabled.

        Specified by:
        warn in interface ULogger
        Parameters:
        parameterizedMsg - - the parameterized message object
        param1 - - the first parameter
        param2 - - the second parameter

      • warn

        public void warn​(java.lang.Object msg,
                 java.lang.Throwable t)
        Log a message object with the WARN level including the stack trace of the Throwablet passed as parameter.
        Specified by:
        warn in interface ULogger
        Parameters:
        msg - the message object to log.
        t - the exception to log, including its stack trace.

      • isErrorEnabled

        public boolean isErrorEnabled()
        Is the logger instance enabled for the ERROR level?
        Specified by:
        isErrorEnabled in interface ULogger
        Returns:
        true if debug is enabled.

      • error

        public void error​(java.lang.Object msg)
        Log a message object with the ERROR level.
        Specified by:
        error in interface ULogger
        Parameters:
        msg - - the message object to be logged

      • error

        public void error​(java.lang.Object parameterizedMsg,
                  java.lang.Object param1)
        Log a parameterized message object at the ERROR level.

        This form is useful in avoiding the superflous object creation problem when invoking this method while it is disabled.

        Specified by:
        error in interface ULogger
        Parameters:
        parameterizedMsg - - the parameterized message object
        param1 - - the parameter

      • error

        public void error​(java.lang.String parameterizedMsg,
                  java.lang.Object param1,
                  java.lang.Object param2)
        Log a parameterized message object at the ERROR level.

        This form is useful in avoiding the superflous object creation problem when invoking this method while it is disabled.

        Specified by:
        error in interface ULogger
        Parameters:
        parameterizedMsg - - the parameterized message object
        param1 - - the first parameter
        param2 - - the second parameter

      • error

        public void error​(java.lang.Object msg,
                  java.lang.Throwable t)
        Log a message object with the ERROR level including the stack trace of the Throwablet passed as parameter.
        Specified by:
        error in interface ULogger
        Parameters:
        msg - the message object to log.
        t - the exception to log, including its stack trace.