Class PrintStreamLogger

  • All Implemented Interfaces:
    InvokerLogger
    Direct Known Subclasses:
    SystemOutLogger

    public class PrintStreamLogger
    extends java.lang.Object
    implements InvokerLogger
    Offers a logger that writes to a print stream like System.out.
    Since:
    2.0.9
    Version:
    $Id: PrintStreamLogger.java 1635406 2014-10-30 06:51:13Z hboutemy $
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.io.PrintStream out
      The print stream to write to, never null.
      private int threshold
      The threshold used to filter messages.
    • Constructor Summary

      Constructors 
      Constructor Description
      PrintStreamLogger()
      Creates a new logger that writes to System.out and has a threshold of InvokerLogger.INFO.
      PrintStreamLogger​(java.io.PrintStream out, int threshold)
      Creates a new logger that writes to the specified print stream.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void debug​(java.lang.String message)
      Logs the specified debug message.
      void debug​(java.lang.String message, java.lang.Throwable throwable)
      Logs the specified debug message and the accompanying exception.
      void error​(java.lang.String message)
      Logs the specified error message.
      void error​(java.lang.String message, java.lang.Throwable throwable)
      Logs the specified error message and the accompanying exception.
      void fatalError​(java.lang.String message)
      Logs the specified fatal error message.
      void fatalError​(java.lang.String message, java.lang.Throwable throwable)
      Logs the specified fatal error message and the accompanying exception.
      int getThreshold()
      Gets the logger's threshold.
      void info​(java.lang.String message)
      Logs the specified info message.
      void info​(java.lang.String message, java.lang.Throwable throwable)
      Logs the specified info message and the accompanying exception.
      boolean isDebugEnabled()
      Tests whether debug output is enabled for this logger.
      boolean isErrorEnabled()
      Tests whether error output is enabled for this logger.
      boolean isFatalErrorEnabled()
      Tests whether fatal error output is enabled for this logger.
      boolean isInfoEnabled()
      Tests whether info output is enabled for this logger.
      boolean isWarnEnabled()
      Tests whether warn output is enabled for this logger.
      private void log​(int level, java.lang.String message, java.lang.Throwable error)
      Writes the specified message and exception to the print stream.
      void setThreshold​(int threshold)
      Sets the logger's threshold.
      void warn​(java.lang.String message)
      Logs the specified warning message.
      void warn​(java.lang.String message, java.lang.Throwable throwable)
      Logs the specified warning message and the accompanying exception.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • out

        private java.io.PrintStream out
        The print stream to write to, never null.
      • threshold

        private int threshold
        The threshold used to filter messages.
    • Constructor Detail

      • PrintStreamLogger

        public PrintStreamLogger()
        Creates a new logger that writes to System.out and has a threshold of InvokerLogger.INFO.
      • PrintStreamLogger

        public PrintStreamLogger​(java.io.PrintStream out,
                                 int threshold)
        Creates a new logger that writes to the specified print stream.
        Parameters:
        out - The print stream to write to, must not be null.
        threshold - The threshold for the logger.
    • Method Detail

      • log

        private void log​(int level,
                         java.lang.String message,
                         java.lang.Throwable error)
        Writes the specified message and exception to the print stream.
        Parameters:
        level - The priority level of the message.
        message - The message to log, may be null.
        error - The exception to log, may be null.
      • debug

        public void debug​(java.lang.String message)
        Description copied from interface: InvokerLogger
        Logs the specified debug message.
        Specified by:
        debug in interface InvokerLogger
        Parameters:
        message - The message to log, may be null.
      • debug

        public void debug​(java.lang.String message,
                          java.lang.Throwable throwable)
        Description copied from interface: InvokerLogger
        Logs the specified debug message and the accompanying exception.
        Specified by:
        debug in interface InvokerLogger
        Parameters:
        message - The message to log, may be null.
        throwable - The exception to log, may be null.
      • info

        public void info​(java.lang.String message)
        Description copied from interface: InvokerLogger
        Logs the specified info message.
        Specified by:
        info in interface InvokerLogger
        Parameters:
        message - The message to log, may be null.
      • info

        public void info​(java.lang.String message,
                         java.lang.Throwable throwable)
        Description copied from interface: InvokerLogger
        Logs the specified info message and the accompanying exception.
        Specified by:
        info in interface InvokerLogger
        Parameters:
        message - The message to log, may be null.
        throwable - The exception to log, may be null.
      • warn

        public void warn​(java.lang.String message)
        Description copied from interface: InvokerLogger
        Logs the specified warning message.
        Specified by:
        warn in interface InvokerLogger
        Parameters:
        message - The message to log, may be null.
      • warn

        public void warn​(java.lang.String message,
                         java.lang.Throwable throwable)
        Description copied from interface: InvokerLogger
        Logs the specified warning message and the accompanying exception.
        Specified by:
        warn in interface InvokerLogger
        Parameters:
        message - The message to log, may be null.
        throwable - The exception to log, may be null.
      • error

        public void error​(java.lang.String message)
        Description copied from interface: InvokerLogger
        Logs the specified error message.
        Specified by:
        error in interface InvokerLogger
        Parameters:
        message - The message to log, may be null.
      • error

        public void error​(java.lang.String message,
                          java.lang.Throwable throwable)
        Description copied from interface: InvokerLogger
        Logs the specified error message and the accompanying exception.
        Specified by:
        error in interface InvokerLogger
        Parameters:
        message - The message to log, may be null.
        throwable - The exception to log, may be null.
      • fatalError

        public void fatalError​(java.lang.String message)
        Description copied from interface: InvokerLogger
        Logs the specified fatal error message.
        Specified by:
        fatalError in interface InvokerLogger
        Parameters:
        message - The message to log, may be null.
      • fatalError

        public void fatalError​(java.lang.String message,
                               java.lang.Throwable throwable)
        Description copied from interface: InvokerLogger
        Logs the specified fatal error message and the accompanying exception.
        Specified by:
        fatalError in interface InvokerLogger
        Parameters:
        message - The message to log, may be null.
        throwable - The exception to log, may be null.
      • isDebugEnabled

        public boolean isDebugEnabled()
        Description copied from interface: InvokerLogger
        Tests whether debug output is enabled for this logger.
        Specified by:
        isDebugEnabled in interface InvokerLogger
        Returns:
        true if messages with priority "debug" or above are logged, false otherwise.
      • isErrorEnabled

        public boolean isErrorEnabled()
        Description copied from interface: InvokerLogger
        Tests whether error output is enabled for this logger.
        Specified by:
        isErrorEnabled in interface InvokerLogger
        Returns:
        true if messages with priority "error" or above are logged, false otherwise.
      • isFatalErrorEnabled

        public boolean isFatalErrorEnabled()
        Description copied from interface: InvokerLogger
        Tests whether fatal error output is enabled for this logger.
        Specified by:
        isFatalErrorEnabled in interface InvokerLogger
        Returns:
        true if messages with priority "fatal" or above are logged, false otherwise.
      • isInfoEnabled

        public boolean isInfoEnabled()
        Description copied from interface: InvokerLogger
        Tests whether info output is enabled for this logger.
        Specified by:
        isInfoEnabled in interface InvokerLogger
        Returns:
        true if messages with priority "info" or above are logged, false otherwise.
      • isWarnEnabled

        public boolean isWarnEnabled()
        Description copied from interface: InvokerLogger
        Tests whether warn output is enabled for this logger.
        Specified by:
        isWarnEnabled in interface InvokerLogger
        Returns:
        true if messages with priority "warn" or above are logged, false otherwise.