POILogger (Bio-Formats API)

java.lang.Object
- loci.poi.util.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)

Field Summary

Fields
Modifier and Type Field and Description

static int DEBUG

static int ERROR

static int FATAL

static int INFO

static int WARN

Fields
Modifier and Type	Field and Description
`static int`	`DEBUG`
`static int`	`ERROR`
`static int`	`FATAL`
`static int`	`INFO`
`static int`	`WARN`

Constructor Summary

Constructors
Constructor and Description

POILogger()
package scope so it cannot be instantiated outside of the util package.

Constructors
Constructor and Description
`POILogger()` package scope so it cannot be instantiated outside of the util package.

Method Summary

Methods
Modifier and Type	Method and Description
`abstract boolean`	`check(int level)` Check if a logger is enabled to log at the specified level
`private void`	`commonLogFormatted(int level, String message, Object[] unflatParams)`
`private Object[]`	`flattenArrays(Object[] objects)` Flattens any contained objects.
`abstract void`	`initialize(String cat)`
`abstract void`	`log(int level, Object obj1)`
`void`	`log(int level, Object obj1, Object obj2)` Log a message.
`void`	`log(int level, Object obj1, Object obj2, Object obj3)` Log a message.
`void`	`log(int level, Object obj1, Object obj2, Object obj3, Object obj4)` Log a message.
`void`	`log(int level, Object obj1, Object obj2, Object obj3, Object obj4, Object obj5)` Log a message.
`void`	`log(int level, Object obj1, Object obj2, Object obj3, Object obj4, Object obj5, Object obj6)` Log a message.
`void`	`log(int level, Object obj1, Object obj2, Object obj3, Object obj4, Object obj5, Object obj6, Object obj7)` Log a message.
`void`	`log(int level, Object obj1, Object obj2, Object obj3, Object obj4, Object obj5, Object obj6, Object obj7, Object obj8)` Log a message.
`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.
`void`	`log(int level, Object obj1, Object obj2, Object obj3, Object obj4, Object obj5, Object obj6, Object obj7, Throwable exception)` Log a message.
`void`	`log(int level, Object obj1, Object obj2, Object obj3, Object obj4, Object obj5, Object obj6, Throwable exception)` Log a message.
`void`	`log(int level, Object obj1, Object obj2, Object obj3, Object obj4, Object obj5, Throwable exception)` Log a message.
`void`	`log(int level, Object obj1, Object obj2, Object obj3, Object obj4, Throwable exception)` Log a message.
`void`	`log(int level, Object obj1, Object obj2, Object obj3, Throwable exception)` Log a message.
`void`	`log(int level, Object obj1, Object obj2, Throwable exception)` Log a message.
`void`	`log(int level, Object obj1, Throwable exception)` Log a message
`void`	`logFormatted(int level, String message, Object obj1)` Logs a formated message.
`void`	`logFormatted(int level, String message, Object obj1, Object obj2)` Logs a formated message.
`void`	`logFormatted(int level, String message, Object obj1, Object obj2, Object obj3)` Logs a formated message.
`void`	`logFormatted(int level, String message, Object obj1, Object obj2, Object obj3, Object obj4)` Logs a formated message.
`private List`	`objectToObjectArray(Object object)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEBUG
```
public static final int DEBUG
```
    See Also:
    Constant Field Values
  - INFO
```
public static final int INFO
```
    See Also:
    Constant Field Values
  - WARN
```
public static final int WARN
```
    See Also:
    Constant Field Values
  - ERROR
```
public static final int ERROR
```
    See Also:
    Constant Field Values
  - FATAL
```
public static final int FATAL
```
    See Also:
    Constant Field Values
- Constructor Detail
  - POILogger
```
POILogger()
```
    package scope so it cannot be instantiated outside of the util package. You need a POILogger? Go to the POILogFactory for one
- 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.
  - commonLogFormatted
```
private void commonLogFormatted(int level,
                      String message,
                      Object[] unflatParams)
```
  - flattenArrays
```
private Object[] flattenArrays(Object[] objects)
```
    Flattens any contained objects. Only tranverses one level deep.
  - objectToObjectArray
```
private List objectToObjectArray(Object object)
```

Class POILogger

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEBUG

INFO

WARN

ERROR

FATAL

Constructor Detail

POILogger

Method Detail

initialize

log

check

log

log

log

log

log

log

log

log

log

log

log

log

log

log

log

logFormatted

logFormatted

logFormatted

logFormatted

commonLogFormatted

flattenArrays

objectToObjectArray