Package org.mapsforge.poi.writer.logging

Class LoggerWrapper

  • public class LoggerWrapper
extends java.util.logging.Logger
    This extension of Java's default logger provides ProgressManager integration that allows forwarding log messages to a GUI. It allows simultaneous logging on an output stream as provided in the base Logger class and to a GUI.

    • Field Summary

      • Fields inherited from class java.util.logging.Logger

        global, GLOBAL_LOGGER_NAME

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static LoggerWrapper getLogger​(java.lang.String name)
      Returns or creates a logger that forwards messages to a ProgressManager.
      static LoggerWrapper getLogger​(java.lang.String name, ProgressManager pm)
      Returns or creates a logger that forwards messages to a ProgressManager.
      void log​(java.util.logging.Level level, java.lang.String msg)  
      static void setDefaultProgressManager​(ProgressManager pm)
      Sets the ProgressManager object that will be used for each LoggerWrapper instance.
      void setProgressManager​(ProgressManager pm)
      This method sets the logger's progress manager that receives certain log messages and forwards them to a GUI.

      • Methods inherited from class java.util.logging.Logger

        addHandler, config, config, entering, entering, entering, exiting, exiting, fine, fine, finer, finer, finest, finest, getAnonymousLogger, getAnonymousLogger, getFilter, getGlobal, getHandlers, getLevel, getLogger, getName, getParent, getResourceBundle, getResourceBundleName, getUseParentHandlers, info, info, isLoggable, log, log, log, log, log, log, logp, logp, logp, logp, logp, logp, logrb, logrb, logrb, logrb, logrb, logrb, logrb, logrb, removeHandler, setFilter, setLevel, setParent, setResourceBundle, setUseParentHandlers, severe, severe, throwing, warning, warning

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getLogger

        public static LoggerWrapper getLogger​(java.lang.String name)
        Returns or creates a logger that forwards messages to a ProgressManager. To create a logger object with a progress manager use getLogger(String, ProgressManager) instead.
        Parameters:
        name - The logger's unique name. By default the calling class' name is used.
        Returns:
        A logger that forwards messages to a ProgressManager.

      • getLogger

        public static LoggerWrapper getLogger​(java.lang.String name,
                                      ProgressManager pm)
        Returns or creates a logger that forwards messages to a ProgressManager. If the logger does not yet have any progress manager assigned, the given one will be used.
        Parameters:
        name - The logger's unique name. By default the calling class' name is used.
        pm - The logger's progress manager. This value is only used if a logger object has to be created or a logger with a given name does not yet have any progress manager assigned or if the default progress manager is used.
        Returns:
        A logger that forwards messages to a ProgressManager.

      • log

        public void log​(java.util.logging.Level level,
                java.lang.String msg)
        Overrides:
        log in class java.util.logging.Logger

      • setDefaultProgressManager

        public static void setDefaultProgressManager​(ProgressManager pm)
        Sets the ProgressManager object that will be used for each LoggerWrapper instance.
        Parameters:
        pm - The progress manager to be used whenever an instance of this class is created.

      • setProgressManager

        public void setProgressManager​(ProgressManager pm)
        This method sets the logger's progress manager that receives certain log messages and forwards them to a GUI. Call this method to override the current ProgressManager.
        Parameters:
        pm - The progress manager to be used.