Package loci.poi.util

Class POILogger

  • Direct Known Subclasses:
    CommonsLogger, NullLogger, SystemOutLogger

    public abstract class POILogger
    extends Object
    A logger interface that strives to make it as easy as possible for developers to write log calls, while simultaneously making those calls as cheap as possible by performing lazy evaluation of the log message.

    Author:
    Marc Johnson (mjohnson at apache dot org), Glen Stampoultzis (glens at apache.org), Nicola Ken Barozzi (nicolaken at apache.org)
    • Method Detail

      • initialize

        public abstract void initialize​(String cat)
      • log

        public abstract void log​(int level,
                                 Object obj1)
      • check

        public abstract boolean check​(int level)
        Check if a logger is enabled to log at the specified level
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first object to place in the message
        obj2 - second object to place in the message
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2,
                        Object obj3)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first Object to place in the message
        obj2 - second Object to place in the message
        obj3 - third Object to place in the message
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2,
                        Object obj3,
                        Object obj4)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first Object to place in the message
        obj2 - second Object to place in the message
        obj3 - third Object to place in the message
        obj4 - fourth Object to place in the message
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2,
                        Object obj3,
                        Object obj4,
                        Object obj5)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first Object to place in the message
        obj2 - second Object to place in the message
        obj3 - third Object to place in the message
        obj4 - fourth Object to place in the message
        obj5 - fifth Object to place in the message
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2,
                        Object obj3,
                        Object obj4,
                        Object obj5,
                        Object obj6)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first Object to place in the message
        obj2 - second Object to place in the message
        obj3 - third Object to place in the message
        obj4 - fourth Object to place in the message
        obj5 - fifth Object to place in the message
        obj6 - sixth Object to place in the message
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2,
                        Object obj3,
                        Object obj4,
                        Object obj5,
                        Object obj6,
                        Object obj7)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first Object to place in the message
        obj2 - second Object to place in the message
        obj3 - third Object to place in the message
        obj4 - fourth Object to place in the message
        obj5 - fifth Object to place in the message
        obj6 - sixth Object to place in the message
        obj7 - seventh Object to place in the message
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2,
                        Object obj3,
                        Object obj4,
                        Object obj5,
                        Object obj6,
                        Object obj7,
                        Object obj8)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first Object to place in the message
        obj2 - second Object to place in the message
        obj3 - third Object to place in the message
        obj4 - fourth Object to place in the message
        obj5 - fifth Object to place in the message
        obj6 - sixth Object to place in the message
        obj7 - seventh Object to place in the message
        obj8 - eighth Object to place in the message
      • log

        public void log​(int level,
                        Object obj1,
                        Throwable exception)
        Log a message
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - The object to log. This is converted to a string.
        exception - An exception to be logged
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2,
                        Throwable exception)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first Object to place in the message
        obj2 - second Object to place in the message
        exception - An exception to be logged
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2,
                        Object obj3,
                        Throwable exception)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first Object to place in the message
        obj2 - second Object to place in the message
        obj3 - third object to place in the message
        exception - An error message to be logged
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2,
                        Object obj3,
                        Object obj4,
                        Throwable exception)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first Object to place in the message
        obj2 - second Object to place in the message
        obj3 - third object to place in the message
        obj4 - fourth object to place in the message
        exception - An exception to be logged
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2,
                        Object obj3,
                        Object obj4,
                        Object obj5,
                        Throwable exception)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first Object to place in the message
        obj2 - second Object to place in the message
        obj3 - third object to place in the message
        obj4 - fourth object to place in the message
        obj5 - fifth object to place in the message
        exception - An exception to be logged
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2,
                        Object obj3,
                        Object obj4,
                        Object obj5,
                        Object obj6,
                        Throwable exception)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first Object to place in the message
        obj2 - second Object to place in the message
        obj3 - third object to place in the message
        obj4 - fourth object to place in the message
        obj5 - fifth object to place in the message
        obj6 - sixth object to place in the message
        exception - An exception to be logged
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2,
                        Object obj3,
                        Object obj4,
                        Object obj5,
                        Object obj6,
                        Object obj7,
                        Throwable exception)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first Object to place in the message
        obj2 - second Object to place in the message
        obj3 - third object to place in the message
        obj4 - fourth object to place in the message
        obj5 - fifth object to place in the message
        obj6 - sixth object to place in the message
        obj7 - seventh object to place in the message
        exception - An exception to be logged
      • log

        public void log​(int level,
                        Object obj1,
                        Object obj2,
                        Object obj3,
                        Object obj4,
                        Object obj5,
                        Object obj6,
                        Object obj7,
                        Object obj8,
                        Throwable exception)
        Log a message. Lazily appends Object parameters together.
        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        obj1 - first Object to place in the message
        obj2 - second Object to place in the message
        obj3 - third object to place in the message
        obj4 - fourth object to place in the message
        obj5 - fifth object to place in the message
        obj6 - sixth object to place in the message
        obj7 - seventh object to place in the message
        obj8 - eighth object to place in the message
        exception - An exception to be logged
      • logFormatted

        public void logFormatted​(int level,
                                 String message,
                                 Object obj1)
        Logs a formated message. The message itself may contain % characters as place holders. This routine will attempt to match the placeholder by looking at the type of parameter passed to obj1.

        If the parameter is an array, it traverses the array first and matches parameters sequentially against the array items. Otherwise the parameters after message are matched in order.

        If the place holder matches against a number it is printed as a whole number. This can be overridden by specifying a precision in the form %n.m where n is the padding for the whole part and m is the number of decimal places to display. n can be excluded if desired. n and m may not be more than 9.

        If the last parameter (after flattening) is a Throwable it is logged specially.

        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        message - The message to log.
        obj1 - The first object to match against.
      • logFormatted

        public void logFormatted​(int level,
                                 String message,
                                 Object obj1,
                                 Object obj2)
        Logs a formated message. The message itself may contain % characters as place holders. This routine will attempt to match the placeholder by looking at the type of parameter passed to obj1.

        If the parameter is an array, it traverses the array first and matches parameters sequentially against the array items. Otherwise the parameters after message are matched in order.

        If the place holder matches against a number it is printed as a whole number. This can be overridden by specifying a precision in the form %n.m where n is the padding for the whole part and m is the number of decimal places to display. n can be excluded if desired. n and m may not be more than 9.

        If the last parameter (after flattening) is a Throwable it is logged specially.

        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        message - The message to log.
        obj1 - The first object to match against.
        obj2 - The second object to match against.
      • logFormatted

        public void logFormatted​(int level,
                                 String message,
                                 Object obj1,
                                 Object obj2,
                                 Object obj3)
        Logs a formated message. The message itself may contain % characters as place holders. This routine will attempt to match the placeholder by looking at the type of parameter passed to obj1.

        If the parameter is an array, it traverses the array first and matches parameters sequentially against the array items. Otherwise the parameters after message are matched in order.

        If the place holder matches against a number it is printed as a whole number. This can be overridden by specifying a precision in the form %n.m where n is the padding for the whole part and m is the number of decimal places to display. n can be excluded if desired. n and m may not be more than 9.

        If the last parameter (after flattening) is a Throwable it is logged specially.

        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        message - The message to log.
        obj1 - The first object to match against.
        obj2 - The second object to match against.
        obj3 - The third object to match against.
      • logFormatted

        public void logFormatted​(int level,
                                 String message,
                                 Object obj1,
                                 Object obj2,
                                 Object obj3,
                                 Object obj4)
        Logs a formated message. The message itself may contain % characters as place holders. This routine will attempt to match the placeholder by looking at the type of parameter passed to obj1.

        If the parameter is an array, it traverses the array first and matches parameters sequentially against the array items. Otherwise the parameters after message are matched in order.

        If the place holder matches against a number it is printed as a whole number. This can be overridden by specifying a precision in the form %n.m where n is the padding for the whole part and m is the number of decimal places to display. n can be excluded if desired. n and m may not be more than 9.

        If the last parameter (after flattening) is a Throwable it is logged specially.

        Parameters:
        level - One of DEBUG, INFO, WARN, ERROR, FATAL
        message - The message to log.
        obj1 - The first object to match against.
        obj2 - The second object to match against.
        obj3 - The third object to match against.
        obj4 - The forth object to match against.