Logger (utils4j)

java.lang.Object
- com.varra.log.Logger

All Implemented Interfaces:

Shutdownable
```
@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class Logger
extends Object
implements Shutdownable
```
Logger - Yet An another fine grained Logger class to log the Application specific messages. Is not based on log4j (to reduce external dependencies). However, if needed, something like log4j could easily be hooked in.

Version:

3.0

Author:

Rajakrishna V. Reddy

See Also:

Log

Method Summary

All Methods Static Methods Instance Methods Concrete 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.
`static Logger`	`getLogger(Class<?> klass)` Retrieve a logger named according to the value of the `name` parameter.
`static Logger`	`getLogger(String name)` Retrieve a logger named according to the value of the `name` parameter.
`String`	`getName()` Gets the name.
`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`	`shutdown(ShutdownMode mode)` Shutdowns this entity properly by performing all the necessary steps to make sure that all the used resources are released properly based on the `ShutdownMode` specified.
`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.
`String`	`toString()`
`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 class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getLogger
```
public static Logger getLogger(Class<?> klass)
```
    Retrieve a logger named according to the value of the name parameter. If the named logger already exists, then the existing instance will be returned. Otherwise, a new instance is created.
    
    Parameters:
    
    klass - the klass
    
    Returns:
    
    the logger
  - getLogger
```
public static Logger getLogger(String name)
```
    Retrieve a logger named according to the value of the name parameter. If the named logger already exists, then the existing instance will be returned. Otherwise, a new instance is created.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the logger
  - getName
```
public String getName()
```
    Gets the name.
    
    Returns:
    
    the name
  - trace
```
public void trace(Object message)
```
    Log a message object with the TRACE level.
    
    Parameters:
    
    message - the message
  - trace
```
public 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
```
public void info(Object message)
```
    Log a message object with the INFO Level.
    
    Parameters:
    
    message - the message
  - info
```
public 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
```
public void debug(Object message)
```
    Log a message object with the DEBUG level.
    
    Parameters:
    
    message - the message
  - debug
```
public 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:
    
    form for more detailed information.
  - warn
```
public void warn(Object message)
```
    Log a message object with the WARN Level.
    
    Parameters:
    
    message - the message
  - warn
```
public 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
```
public void error(Object message)
```
    Log a message object with the ERROR Level..
    
    Parameters:
    
    message - the message
  - error
```
public 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
```
public void fatal(Object message)
```
    Log a message object with the FATAL Level.
    
    Parameters:
    
    message - the message
  - fatal
```
public 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
```
public 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
    
    Parameters:
    
    message - the message INFO are not adequate.
  - test
```
public 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
```
public 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
```
public 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
```
public 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
```
public 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
```
public 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
```
public MyLogLevel getLevel()
```
    Returns the assigned MyLogLevel, if any, for this Category.
    
    Returns:
    
    MyLogLevel - the assigned Level, can be null. the level
  - shutdown
```
public void shutdown(ShutdownMode mode)
```
    Description copied from interface: Shutdownable
    
    Shutdowns this entity properly by performing all the necessary steps to make sure that all the used resources are released properly based on the ShutdownMode specified.
    
    Specified by:
    
    shutdown in interface Shutdownable
    
    Parameters:
    
    mode - the mode
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Logger

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getLogger

getLogger

getName

trace

trace

info

info

debug

debug

warn

warn

error

error

fatal

fatal

test

test

log

log

isDebugEnabled

isInfoEnabled

setLevel

getLevel

shutdown

toString