Class XRLog


  • public class XRLog
    extends java.lang.Object
    Utility class for using the java.util.logging package. Relies on the standard configuration for logging, but gives easier access to the various logs (plumbing.load, .init, .render)
    Author:
    empty
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String CASCADE  
      static java.lang.String CONFIG  
      static java.lang.String CSS_PARSE  
      static java.lang.String EXCEPTION  
      static java.lang.String GENERAL  
      static java.lang.String INIT  
      static java.lang.String JUNIT  
      static java.lang.String LAYOUT  
      static java.lang.String LOAD  
      static java.lang.String MATCH  
      static java.lang.String RENDER  
      static java.lang.String XML_ENTITIES  
    • Constructor Summary

      Constructors 
      Constructor Description
      XRLog()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void cascade​(java.lang.String msg)  
      static void cascade​(java.util.logging.Level level, java.lang.String msg)  
      static void cascade​(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable th)  
      static void cssParse​(java.lang.String msg)  
      static void cssParse​(java.util.logging.Level level, java.lang.String msg)  
      static void cssParse​(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable th)  
      static void exception​(java.lang.String msg)  
      static void exception​(java.lang.String msg, java.lang.Throwable th)  
      static void general​(java.lang.String msg)  
      static void general​(java.util.logging.Level level, java.lang.String msg)  
      static void general​(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable th)  
      static XRLogger getLoggerImpl()  
      static void init​(java.lang.String msg)  
      static void init​(java.util.logging.Level level, java.lang.String msg)  
      static void init​(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable th)  
      static boolean isLoggingEnabled()
      Whether logging is on or off.
      static void junit​(java.lang.String msg)  
      static void junit​(java.util.logging.Level level, java.lang.String msg)  
      static void junit​(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable th)  
      static void layout​(java.lang.String msg)  
      static void layout​(java.util.logging.Level level, java.lang.String msg)  
      static void layout​(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable th)  
      static java.util.List listRegisteredLoggers()
      Returns a list of all loggers that will be accessed by XRLog.
      static void load​(java.lang.String msg)  
      static void load​(java.util.logging.Level level, java.lang.String msg)  
      static void load​(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable th)  
      static void log​(java.lang.String where, java.util.logging.Level level, java.lang.String msg)  
      static void log​(java.lang.String where, java.util.logging.Level level, java.lang.String msg, java.lang.Throwable th)  
      static void main​(java.lang.String[] args)  
      static void match​(java.lang.String msg)  
      static void match​(java.util.logging.Level level, java.lang.String msg)  
      static void match​(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable th)  
      static void render​(java.lang.String msg)  
      static void render​(java.util.logging.Level level, java.lang.String msg)  
      static void render​(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable th)  
      static void setLevel​(java.lang.String log, java.util.logging.Level level)  
      static void setLoggerImpl​(XRLogger loggerImpl)  
      static void setLoggingEnabled​(boolean loggingEnabled)
      Turns logging on or off, without affecting logging configuration.
      static void xmlEntities​(java.lang.String msg)  
      static void xmlEntities​(java.util.logging.Level level, java.lang.String msg)  
      static void xmlEntities​(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable th)  
      • Methods inherited from class java.lang.Object

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

      • CONFIG

        public static final java.lang.String CONFIG
      • EXCEPTION

        public static final java.lang.String EXCEPTION
      • GENERAL

        public static final java.lang.String GENERAL
      • INIT

        public static final java.lang.String INIT
      • JUNIT

        public static final java.lang.String JUNIT
      • LOAD

        public static final java.lang.String LOAD
      • MATCH

        public static final java.lang.String MATCH
      • CASCADE

        public static final java.lang.String CASCADE
      • XML_ENTITIES

        public static final java.lang.String XML_ENTITIES
      • CSS_PARSE

        public static final java.lang.String CSS_PARSE
      • LAYOUT

        public static final java.lang.String LAYOUT
      • RENDER

        public static final java.lang.String RENDER
    • Constructor Detail

      • XRLog

        public XRLog()
    • Method Detail

      • listRegisteredLoggers

        public static java.util.List listRegisteredLoggers()
        Returns a list of all loggers that will be accessed by XRLog. Each entry is a String with a logger name, which can be used to retrieve the logger using the corresponding Logging API; example name might be "org.xhtmlrenderer.config"
        Returns:
        List of loggers, never null.
      • cssParse

        public static void cssParse​(java.lang.String msg)
      • cssParse

        public static void cssParse​(java.util.logging.Level level,
                                    java.lang.String msg)
      • cssParse

        public static void cssParse​(java.util.logging.Level level,
                                    java.lang.String msg,
                                    java.lang.Throwable th)
      • xmlEntities

        public static void xmlEntities​(java.lang.String msg)
      • xmlEntities

        public static void xmlEntities​(java.util.logging.Level level,
                                       java.lang.String msg)
      • xmlEntities

        public static void xmlEntities​(java.util.logging.Level level,
                                       java.lang.String msg,
                                       java.lang.Throwable th)
      • cascade

        public static void cascade​(java.lang.String msg)
      • cascade

        public static void cascade​(java.util.logging.Level level,
                                   java.lang.String msg)
      • cascade

        public static void cascade​(java.util.logging.Level level,
                                   java.lang.String msg,
                                   java.lang.Throwable th)
      • exception

        public static void exception​(java.lang.String msg)
      • exception

        public static void exception​(java.lang.String msg,
                                     java.lang.Throwable th)
      • general

        public static void general​(java.lang.String msg)
      • general

        public static void general​(java.util.logging.Level level,
                                   java.lang.String msg)
      • general

        public static void general​(java.util.logging.Level level,
                                   java.lang.String msg,
                                   java.lang.Throwable th)
      • init

        public static void init​(java.lang.String msg)
      • init

        public static void init​(java.util.logging.Level level,
                                java.lang.String msg)
      • init

        public static void init​(java.util.logging.Level level,
                                java.lang.String msg,
                                java.lang.Throwable th)
      • junit

        public static void junit​(java.lang.String msg)
      • junit

        public static void junit​(java.util.logging.Level level,
                                 java.lang.String msg)
      • junit

        public static void junit​(java.util.logging.Level level,
                                 java.lang.String msg,
                                 java.lang.Throwable th)
      • load

        public static void load​(java.lang.String msg)
      • load

        public static void load​(java.util.logging.Level level,
                                java.lang.String msg)
      • load

        public static void load​(java.util.logging.Level level,
                                java.lang.String msg,
                                java.lang.Throwable th)
      • match

        public static void match​(java.lang.String msg)
      • match

        public static void match​(java.util.logging.Level level,
                                 java.lang.String msg)
      • match

        public static void match​(java.util.logging.Level level,
                                 java.lang.String msg,
                                 java.lang.Throwable th)
      • layout

        public static void layout​(java.lang.String msg)
      • layout

        public static void layout​(java.util.logging.Level level,
                                  java.lang.String msg)
      • layout

        public static void layout​(java.util.logging.Level level,
                                  java.lang.String msg,
                                  java.lang.Throwable th)
      • render

        public static void render​(java.lang.String msg)
      • render

        public static void render​(java.util.logging.Level level,
                                  java.lang.String msg)
      • render

        public static void render​(java.util.logging.Level level,
                                  java.lang.String msg,
                                  java.lang.Throwable th)
      • log

        public static void log​(java.lang.String where,
                               java.util.logging.Level level,
                               java.lang.String msg)
      • log

        public static void log​(java.lang.String where,
                               java.util.logging.Level level,
                               java.lang.String msg,
                               java.lang.Throwable th)
      • main

        public static void main​(java.lang.String[] args)
      • setLevel

        public static void setLevel​(java.lang.String log,
                                    java.util.logging.Level level)
      • isLoggingEnabled

        public static boolean isLoggingEnabled()
        Whether logging is on or off.
        Returns:
        Returns true if logging is enabled, false if not. Corresponds to configuration file property xr.util-logging.loggingEnabled, or to value passed to setLoggingEnabled(bool).
      • setLoggingEnabled

        public static void setLoggingEnabled​(boolean loggingEnabled)
        Turns logging on or off, without affecting logging configuration.
        Parameters:
        loggingEnabled - Flag whether logging is enabled or not; if false, all logging calls fail silently. Corresponds to configuration file property xr.util-logging.loggingEnabled
      • getLoggerImpl

        public static XRLogger getLoggerImpl()
      • setLoggerImpl

        public static void setLoggerImpl​(XRLogger loggerImpl)