Logger (LSST CCS - Utilities 2.1.32 API)

java.lang.Object
- org.lsst.ccs.utilities.logging.Logger

```
public class Logger
extends Object
```
Wrapper around java.util.Logger, kept for backward compatibility, should not be used in new code. The instances are not cached (so better have only one per package)
Many of those are intended to replace log4j invocations by just changing the import directives. The mapping from log4J Levels is operated this way
```
 finest -> finest
 debug-> finer
 fine-> fine
 info -> info
 warn -> warning
 error -> severe
 fatal -> severe
 
```
Logging methods that return a boolean can be used through assert calls (they always return true).
Do not use this Logger for admin purpose (setting a level, a Filter, a Formatter or a Handler): use the corresponding java.util.logging.Logger instead.
Author:

bamade

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`LogRecord`	`createLogRecord(Level level, String message)` creates a simple log record.
`boolean`	`debug(Object message)` logs a message at FINE Level
`void`	`debug(Object message, Throwable throwable)` logs a message at FINER Level
`boolean`	`decoupledLog(long delay, Level level, String message, Object argument)` Deprecated.
`boolean`	`decoupledLog(long delay, Level level, String message, Object[] arguments)` Deprecated.
`void`	`decoupledLog(long delay, Level level, String message, Throwable throwable)` Deprecated.
`void`	`decoupledLog(long delay, LogRecord record)` Deprecated.
`void`	`error(Object message)` logs a message at SEVERE Level (use preferably the error method that uses a `Throwable` parameter)
`void`	`error(Object message, Throwable throwable)` logs a message at SEVERE Level
`void`	`fatal(Object message)` logs a message at SEVERE Level (use preferably the fatal method that uses a `Throwable` parameter)
`void`	`fatal(Object message, Throwable throwable)` logs a message at SEVERE Level
`boolean`	`fine(Object message)` logs a message at FINE Level
`boolean`	`finest(Object message)` logs a message at FINEST level
`Level`	`getLevel()`
`static Logger`	`getLogger(String name)` Factory method to obtain an instance.
`String`	`getName()`
`protected Logger`	`getParent()`
`boolean`	`info(Object message)` logs a message at INFO Level
`void`	`info(Object message, Throwable throwable)` logs a message at INFO Level
`boolean`	`isDebugEnabled()` tells if the FINER level is activated for the corresponding JUL Logger.
`boolean`	`isInfoEnabled()` tells if the INFO level is activated for the corresponding JUL Logger.
`boolean`	`isLoggable(Level level)` tells if the corresponding JUL level is activated for the corresponding JUL Logger.
`boolean`	`log(Level level, String message, Object argument)` Does the same as the equivalent standard JUL method.
`boolean`	`log(Level level, String message, Object[] arguments)` Does the same as the equivalent standard JUL method.
`void`	`log(Level level, String message, Throwable throwable)` does the same as the equivalent standard JUL method.
`void`	`log(LogRecord record)` utility method to send a `LogRecord` to the corresponding JUL logger and to a list of other loggers.
`protected boolean`	`logMessage(Level level, Object message)` utility method to log a message with a Level
`protected void`	`logSimpleThrowable(Level level, Object message, Throwable throwable)` utility method to forward a `Throwable` and a message to the loggers.
`void`	`setLevel(Level level)`
`void`	`severe(Object message)` logs a message at SEVERE Level (use preferably the severe method that uses a `Throwable` parameter)
`void`	`severe(Object message, Throwable throwable)` logs a message at SEVERE Level
`void`	`throwing(String sourceClass, String sourceMethod, Throwable throwable)` invokes the `throwing` method on the corresponding JUL logger.
`boolean`	`warn(Object message)` logs a message at WARNING Level
`void`	`warn(Object message, Throwable throwable)` logs a message at WARNING Level
`boolean`	`warning(Object message)` logs a message at WARNING Level
`void`	`warning(Object message, Throwable throwable)` logs a message at WARNING Level

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

- Method Detail
  - getLogger
```
public static Logger getLogger(String name)
```
    Factory method to obtain an instance. This method returns a new instance every time it is called.
    
    Parameters:
    
    name - usually a package name (top of hierarchy is "" empty String).
    
    Returns:
    
    New Logger instance.
  - getName
```
public String getName()
```
    Returns:
    
    the name of the Logger
  - getLevel
```
public Level getLevel()
```
    Returns:
    
    the level of the associated JUL logger
  - setLevel
```
public void setLevel(Level level)
```
  - getParent
```
protected Logger getParent()
```
    Returns:
    
    the parent of the associated JUL logger
  - createLogRecord
```
public LogRecord createLogRecord(Level level,
                                 String message)
```
    creates a simple log record. This factory manipulates the caller information (className, method Name) by getting rid of any information coming from a package that contains "logging" (or "log4j").
    note that the LogRecord is automatically marked with a sequenceNumber that can be used by Handlers that want to detect duplicate publications.
    
    Parameters:
    
    level - JUL Level
    
    message - (avoid null values)
    
    Returns:
    
    a simple LogRecord
  - logMessage
```
protected boolean logMessage(Level level,
                             Object message)
```
    utility method to log a message with a Level
    
    Parameters:
    
    level - JUL level
    
    message - (avoid null values)
    
    Returns:
    
    true
  - finest
```
public boolean finest(Object message)
```
    logs a message at FINEST level
    
    Parameters:
    
    message -
    
    Returns:
    
    true
  - debug
```
public boolean debug(Object message)
```
    logs a message at FINE Level
    
    Parameters:
    
    message -
    
    Returns:
    
    true
  - fine
```
public boolean fine(Object message)
```
    logs a message at FINE Level
    
    Parameters:
    
    message -
    
    Returns:
    
    true
  - info
```
public boolean info(Object message)
```
    logs a message at INFO Level
    
    Parameters:
    
    message -
    
    Returns:
    
    true
  - warn
```
public boolean warn(Object message)
```
    logs a message at WARNING Level
    
    Parameters:
    
    message -
    
    Returns:
    
    true
  - warning
```
public boolean warning(Object message)
```
    logs a message at WARNING Level
    
    Parameters:
    
    message -
    
    Returns:
    
    true
  - error
```
public void error(Object message)
```
    logs a message at SEVERE Level (use preferably the error method that uses a Throwable parameter)
    
    Parameters:
    
    message -
  - fatal
```
public void fatal(Object message)
```
    logs a message at SEVERE Level (use preferably the fatal method that uses a Throwable parameter)
    
    Parameters:
    
    message -
  - severe
```
public void severe(Object message)
```
    logs a message at SEVERE Level (use preferably the severe method that uses a Throwable parameter)
    
    Parameters:
    
    message -
  - isDebugEnabled
```
public boolean isDebugEnabled()
```
    tells if the FINER level is activated for the corresponding JUL Logger. (to be used if a subsequent logging call is costly)
    
    Returns:
  - isInfoEnabled
```
public boolean isInfoEnabled()
```
    tells if the INFO level is activated for the corresponding JUL Logger. (to be used if a subsequent logging call is costly)
    
    Returns:
  - logSimpleThrowable
```
protected void logSimpleThrowable(Level level,
                                  Object message,
                                  Throwable throwable)
```
    utility method to forward a Throwable and a message to the loggers.
    
    Parameters:
    
    level - JUL level
    
    message -
    
    throwable -
  - fatal
```
public void fatal(Object message,
                  Throwable throwable)
```
    logs a message at SEVERE Level
    
    Parameters:
    
    message -
    
    throwable -
  - severe
```
public void severe(Object message,
                   Throwable throwable)
```
    logs a message at SEVERE Level
    
    Parameters:
    
    message -
    
    throwable -
  - error
```
public void error(Object message,
                  Throwable throwable)
```
    logs a message at SEVERE Level
    
    Parameters:
    
    message -
    
    throwable -
  - warn
```
public void warn(Object message,
                 Throwable throwable)
```
    logs a message at WARNING Level
    
    Parameters:
    
    message -
    
    throwable -
  - warning
```
public void warning(Object message,
                    Throwable throwable)
```
    logs a message at WARNING Level
    
    Parameters:
    
    message -
    
    throwable -
  - throwing
```
public void throwing(String sourceClass,
                     String sourceMethod,
                     Throwable throwable)
```
    invokes the throwing method on the corresponding JUL logger.
    
    Parameters:
    
    sourceClass -
    
    sourceMethod -
    
    throwable -
  - info
```
public void info(Object message,
                 Throwable throwable)
```
    logs a message at INFO Level
    
    Parameters:
    
    message -
    
    throwable -
  - debug
```
public void debug(Object message,
                  Throwable throwable)
```
    logs a message at FINER Level
    
    Parameters:
    
    message -
    
    throwable -
  - isLoggable
```
public boolean isLoggable(Level level)
```
    tells if the corresponding JUL level is activated for the corresponding JUL Logger. (to be used if a subsequent logging call is costly)
    
    Parameters:
    
    level - The level for which we are asking if it's loggable
    
    Returns:
  - log
```
public void log(LogRecord record)
```
    utility method to send a LogRecord to the corresponding JUL logger and to a list of other loggers.
    
    Parameters:
    
    record - (should be created with the createLogRecord factory :otherwise stack information will be wrong)
  - decoupledLog
```
@Deprecated
public void decoupledLog(long delay,
                                     LogRecord record)
```
    Deprecated.
    
    Kept for backward compatibility. Equivalent to log(LogRecord).
  - log
```
public boolean log(Level level,
                   String message,
                   Object argument)
```
    Does the same as the equivalent standard JUL method.
    
    Parameters:
    
    level - JUL level
    
    message -
    
    argument -
    
    Returns:
    
    true.
  - decoupledLog
```
@Deprecated
public boolean decoupledLog(long delay,
                                        Level level,
                                        String message,
                                        Object argument)
```
    Deprecated.
    
    Kept for backward compatibility. Equivalent to log(Level, String, Object).
    
    Returns:
    
    true.
  - log
```
public boolean log(Level level,
                   String message,
                   Object[] arguments)
```
    Does the same as the equivalent standard JUL method.
    
    Parameters:
    
    level - JUL level
    
    message -
    
    arguments -
    
    Returns:
    
    true
  - decoupledLog
```
@Deprecated
public boolean decoupledLog(long delay,
                                        Level level,
                                        String message,
                                        Object[] arguments)
```
    Deprecated.
    
    Kept for backward compatibility. Equivalent to log(Level, String, Object[]).
    
    Returns:
    
    true.
  - log
```
public void log(Level level,
                String message,
                Throwable throwable)
```
    does the same as the equivalent standard JUL method.
    
    Parameters:
    
    level - JUL level
    
    message -
    
    throwable -
  - decoupledLog
```
@Deprecated
public void decoupledLog(long delay,
                                     Level level,
                                     String message,
                                     Throwable throwable)
```
    Deprecated.
    
    Kept for backward compatibility. Equivalent to log(Level, String, Throwable).

Class Logger

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getLogger

getName

getLevel

setLevel

getParent

createLogRecord

logMessage

finest

debug

fine

info

warn

warning

error

fatal

severe

isDebugEnabled

isInfoEnabled

logSimpleThrowable

fatal

severe

error

warn

warning

throwing

info

debug

isLoggable

log

decoupledLog

log

decoupledLog

log

decoupledLog

log

decoupledLog