Log (utils4j)

All Superinterfaces:

Shutdownable

All Known Implementing Classes:

ConsoleLogger, Log4jLogger, NoLogger
```
@InterfaceAudience.Public
 @InterfaceStability.Evolving
public interface Log
extends Shutdownable
```
A convenient way of implementing the Logger functionality. Very useful to integrate with the third party Logger implementations.
Just implement this with the preferred logging framework whatever you choose.
Note: Actual implementations need to take care of Log Level enabled/disabled check before processing to log the messages, if you are not using the third party framework.

Version:

3.0

Author:

Rajakrishna V. Reddy

See Also:

Logger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`debug(Object message)` Log a message object with the `DEBUG` level.
`void`	`debug(Object message, Throwable t)` Log a message object with the `DEBUG` level including the stack trace of the `Throwable` `t` passed as parameter.
`void`	`error(Object message)` Log a message object with the `ERROR` Level..
`void`	`error(Object message, Throwable t)` Log a message object with the `ERROR` level including the stack trace of the `Throwable` `t` passed as parameter.
`void`	`fatal(Object message)` Log a message object with the `FATAL` Level.
`void`	`fatal(Object message, Throwable t)` Log a message object with the `FATAL` level including the stack trace of the `Throwable` `t` passed as parameter.
`MyLogLevel`	`getLevel()` Returns the assigned `MyLogLevel`, if any, for this Category.
`String`	`getName()` Gets the name of the logger.
`void`	`info(Object message)` Log a message object with the `INFO` Level.
`void`	`info(Object message, Throwable t)` Log a message object with the `INFO` level including the stack trace of the `Throwable` `t` passed as parameter.
`boolean`	`isDebugEnabled()` Check whether this category is enabled for the `DEBUG` Level.
`boolean`	`isInfoEnabled()` Check whether this category is enabled for the info Level.
`void`	`log(Object message, int level, String levelString)` Log a message object with the `MyLevel` (an user defined) Level.
`void`	`log(Object message, Throwable t)` Log a message object with the `MyLevel` (an user defined) Level including the stack trace of the `Throwable` `t` passed as parameter.
`void`	`setLevel(MyLogLevel level)` Set the level of this Category.
`void`	`setName(String name)` Sets the name.
`void`	`test(Object message)` Log a message object with the test Level.
`void`	`test(Object message, Throwable t)` Log a message object with the test level including the stack trace of the `Throwable` `t` passed as parameter.
`void`	`trace(Object message)` Log a message object with the `TRACE` level.
`void`	`trace(Object message, Throwable t)` Log a message object with the `TRACE` level including the stack trace of the `Throwablet` passed as parameter.
`void`	`warn(Object message)` Log a message object with the `WARN` Level.
`void`	`warn(Object message, Throwable t)` Log a message with the `WARN` level including the stack trace of the `Throwable` `t` passed as parameter.

Methods inherited from interface com.varra.util.Shutdownable
shutdown

- Method Detail
  - getName
```
String getName()
```
    Gets the name of the logger.
    
    Returns:
    
    the name
  - setName
```
void setName(String name)
```
    Sets the name.
    
    Parameters:
    
    name - the name
  - trace
```
void trace(Object message)
```
    Log a message object with the TRACE level.
    
    Parameters:
    
    message - the message
  - trace
```
void trace(Object message,
           Throwable t)
```
    Log a message object with the TRACE level including the stack trace of the Throwablet passed as parameter.
    See debug(Object) form for more detailed information.
    
    Parameters:
    
    message - the message
    
    t - the t
  - info
```
void info(Object message)
```
    Log a message object with the INFO Level.
    
    Parameters:
    
    message - the message
  - info
```
void info(Object message,
          Throwable t)
```
    Log a message object with the INFO level including the stack trace of the Throwable t passed as parameter.
    See info(Object) for more detailed information.
    
    Parameters:
    
    message - the message
    
    t - the t
  - debug
```
void debug(Object message)
```
    Log a message object with the DEBUG level.
    
    Parameters:
    
    message - the message
  - debug
```
void debug(Object message,
           Throwable t)
```
    Log a message object with the DEBUG level including the stack trace of the Throwable t passed as parameter.
    
    Parameters:
    
    message - the message
    
    t - the t
    
    See Also:
    
    debug(java.lang.Object)
  - warn
```
void warn(Object message)
```
    Log a message object with the WARN Level.
    
    Parameters:
    
    message - the message
  - warn
```
void warn(Object message,
          Throwable t)
```
    Log a message with the WARN level including the stack trace of the Throwable t passed as parameter.
    
    Parameters:
    
    message - the message
    
    t - the t
    
    See Also:
    
    for more detailed information.
  - error
```
void error(Object message)
```
    Log a message object with the ERROR Level..
    
    Parameters:
    
    message - the message
  - error
```
void error(Object message,
           Throwable t)
```
    Log a message object with the ERROR level including the stack trace of the Throwable t passed as parameter.
    
    Parameters:
    
    message - the message
    
    t - the t
    
    See Also:
    
    form for more detailed information.
  - fatal
```
void fatal(Object message)
```
    Log a message object with the FATAL Level.
    
    Parameters:
    
    message - the message
  - fatal
```
void fatal(Object message,
           Throwable t)
```
    Log a message object with the FATAL level including the stack trace of the Throwable t passed as parameter.
    
    Parameters:
    
    message - the message
    
    t - the t
    
    See Also:
    
    for more detailed information.
  - test
```
void test(Object message)
```
    Log a message object with the test Level.
    
    Note: Is useful for testing purpose, if the code is moved to production just you can disable this level instead of removing the log entries in classes spread across in your Application.
    There will be a situation where DEBUG and INFO are not adequate.
    
    Parameters:
    
    message - the message
  - test
```
void test(Object message,
          Throwable t)
```
    Log a message object with the test level including the stack trace of the Throwable t passed as parameter.
    
    Parameters:
    
    message - the message
    
    t - the t
    
    See Also:
    
    for more detailed information.
  - log
```
void log(Object message,
         int level,
         String levelString)
```
    Log a message object with the MyLevel (an user defined) Level.
    
    Note: Is very useful for the developers to use for specific purpose, like for displaying the time elapsed for an event or for showing the statistics or for showing the progress of a task..etc
    
    Parameters:
    
    message - the message
    
    level - the level
    
    levelString - the level string
  - log
```
void log(Object message,
         Throwable t)
```
    Log a message object with the MyLevel (an user defined) Level
    including the stack trace of the Throwable t passed as parameter.
    
    Parameters:
    
    message - the message
    
    t - the t
    
    See Also:
    
    for more detailed information.
  - isDebugEnabled
```
boolean isDebugEnabled()
```
    Check whether this category is enabled for the DEBUG Level.
    This function is intended to lessen the computational cost of disabled log debug statements.
    For some cat Category object, when you write,
```
 logger.debug("This is entry number: " + i);
 
```
    You incur the cost constructing the message, concatenatiion in this case, regardless of whether the message is logged or not.
    If you are worried about speed, then you should write
```
 if (logger.isDebugEnabled())
 {
        logger.debug("This is entry number: " + i);
 }
 
```
    This way you will not incur the cost of parameter construction if debugging is disabled for cat. On the other hand, if the cat is debug enabled, you will incur the cost of evaluating whether the category is debug enabled twice. Once in isDebugEnabled and once in the debug. This is an insignificant overhead since evaluating a category takes about 1%% of the time it takes to actually log.
    Returns:
    
    boolean - true if this category is debug enabled, false otherwise.
  - isInfoEnabled
```
boolean isInfoEnabled()
```
    Check whether this category is enabled for the info Level. See also isDebugEnabled().
    
    Returns:
    
    boolean - true if this category is enabled for level info, false otherwise.
  - setLevel
```
void setLevel(MyLogLevel level)
```
    Set the level of this Category. If you are passing any of MyLogLevel.DEBUG, MyLogLevel.INFO, MyLogLevel.WARN, MyLogLevel.ERROR, MyLogLevel.FATAL as a parameter, you need to case them as MyLogLevel.
    As in
```
 logger.setLevel((MyLogLevel) MyLogLevel.DEBUG);
 
```
    Null values are not entertained.
    Parameters:
    
    level - the new level
  - getLevel
```
MyLogLevel getLevel()
```
    Returns the assigned MyLogLevel, if any, for this Category.
    
    Returns:
    
    MyLogLevel - the assigned Level, can be null. the level

Interface Log

Method Summary

Methods inherited from interface com.varra.util.Shutdownable

Method Detail

getName

setName

trace

trace

info

info

debug

debug

warn

warn

error

error

fatal

fatal

test

test

log

log

isDebugEnabled

isInfoEnabled

setLevel

getLevel