NoLogger (utils4j)

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

All Implemented Interfaces:

Log, Shutdownable
```
@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class NoLogger
extends Object
implements Log
```
Silent Logger which swallows all the logs, will be the default logger for all the logger messages. Note: Set logger like VarraProperties.setProperty(java.lang.String, java.lang.Object)( LoggerConstants.LOG_CLASS_FQ_NAME, Log4jLogger[ConsoleLogger].class.getName()

Version:

1.0

Author:

Rajakrishna V. Reddy

Constructor Summary

Constructors
Constructor and Description

NoLogger()
Instantiates a new no logger.

Constructors
Constructor and Description
`NoLogger()` Instantiates a new no logger.

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.
`String`	`getName()` Gets the name of the logger.
`static NoLogger`	`getNoLogger()` Gets the no 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`	`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.
`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, toString, wait, wait, wait

- Constructor Detail
  - NoLogger
```
public NoLogger()
```
    Instantiates a new no logger.
- Method Detail
  - getNoLogger
```
public static NoLogger getNoLogger()
```
    Gets the no logger.
    
    Returns:
    
    the noLogger
  - getName
```
public String getName()
```
    Description copied from interface: Log
    
    Gets the name of the logger.
    
    Specified by:
    
    getName in interface Log
    
    Returns:
    
    the name
  - setName
```
public void setName(String name)
```
    Description copied from interface: Log
    
    Sets the name.
    
    Specified by:
    
    setName in interface Log
    
    Parameters:
    
    name - the name
  - trace
```
public void trace(Object message)
```
    Description copied from interface: Log
    
    Log a message object with the TRACE level.
    
    Specified by:
    
    trace in interface Log
    
    Parameters:
    
    message - the message
  - trace
```
public void trace(Object message,
                  Throwable t)
```
    Description copied from interface: Log
    
    Log a message object with the TRACE level including the stack trace of the Throwablet passed as parameter.
    See Log.debug(Object) form for more detailed information.
    
    Specified by:
    
    trace in interface Log
    
    Parameters:
    
    message - the message
    
    t - the t
  - info
```
public void info(Object message)
```
    Description copied from interface: Log
    
    Log a message object with the INFO Level.
    
    Specified by:
    
    info in interface Log
    
    Parameters:
    
    message - the message
  - info
```
public void info(Object message,
                 Throwable t)
```
    Description copied from interface: Log
    
    Log a message object with the INFO level including the stack trace of the Throwable t passed as parameter.
    See Log.info(Object) for more detailed information.
    
    Specified by:
    
    info in interface Log
    
    Parameters:
    
    message - the message
    
    t - the t
  - debug
```
public void debug(Object message)
```
    Description copied from interface: Log
    
    Log a message object with the DEBUG level.
    
    Specified by:
    
    debug in interface Log
    
    Parameters:
    
    message - the message
  - debug
```
public void debug(Object message,
                  Throwable t)
```
    Description copied from interface: Log
    
    Log a message object with the DEBUG level including the stack trace of the Throwable t passed as parameter.
    
    Specified by:
    
    debug in interface Log
    
    Parameters:
    
    message - the message
    
    t - the t
    
    See Also:
    
    Log.debug(java.lang.Object)
  - warn
```
public void warn(Object message)
```
    Description copied from interface: Log
    
    Log a message object with the WARN Level.
    
    Specified by:
    
    warn in interface Log
    
    Parameters:
    
    message - the message
  - warn
```
public void warn(Object message,
                 Throwable t)
```
    Description copied from interface: Log
    
    Log a message with the WARN level including the stack trace of the Throwable t passed as parameter.
    
    Specified by:
    
    warn in interface Log
    
    Parameters:
    
    message - the message
    
    t - the t
    
    See Also:
    
    for more detailed information.
  - error
```
public void error(Object message)
```
    Description copied from interface: Log
    
    Log a message object with the ERROR Level..
    
    Specified by:
    
    error in interface Log
    
    Parameters:
    
    message - the message
  - error
```
public void error(Object message,
                  Throwable t)
```
    Description copied from interface: Log
    
    Log a message object with the ERROR level including the stack trace of the Throwable t passed as parameter.
    
    Specified by:
    
    error in interface Log
    
    Parameters:
    
    message - the message
    
    t - the t
    
    See Also:
    
    form for more detailed information.
  - fatal
```
public void fatal(Object message)
```
    Description copied from interface: Log
    
    Log a message object with the FATAL Level.
    
    Specified by:
    
    fatal in interface Log
    
    Parameters:
    
    message - the message
  - fatal
```
public void fatal(Object message,
                  Throwable t)
```
    Description copied from interface: Log
    
    Log a message object with the FATAL level including the stack trace of the Throwable t passed as parameter.
    
    Specified by:
    
    fatal in interface Log
    
    Parameters:
    
    message - the message
    
    t - the t
    
    See Also:
    
    for more detailed information.
  - test
```
public void test(Object message)
```
    Description copied from interface: Log
    
    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.
    
    Specified by:
    
    test in interface Log
    
    Parameters:
    
    message - the message
  - test
```
public void test(Object message,
                 Throwable t)
```
    Description copied from interface: Log
    
    Log a message object with the test level including the stack trace of the Throwable t passed as parameter.
    
    Specified by:
    
    test in interface Log
    
    Parameters:
    
    message - the message
    
    t - the t
    
    See Also:
    
    for more detailed information.
  - log
```
public void log(Object message,
                int level,
                String levelString)
```
    Description copied from interface: Log
    
    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
    
    Specified by:
    
    log in interface Log
    
    Parameters:
    
    message - the message
    
    level - the level
    
    levelString - the level string
  - log
```
public void log(Object message,
                Throwable t)
```
    Description copied from interface: Log
    
    Log a message object with the MyLevel (an user defined) Level
    including the stack trace of the Throwable t passed as parameter.
    
    Specified by:
    
    log in interface Log
    
    Parameters:
    
    message - the message
    
    t - the t
    
    See Also:
    
    for more detailed information.
  - isDebugEnabled
```
public boolean isDebugEnabled()
```
    Description copied from interface: Log
    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.
    Specified by:
    
    isDebugEnabled in interface Log
    
    Returns:
    
    boolean - true if this category is debug enabled, false otherwise.
  - isInfoEnabled
```
public boolean isInfoEnabled()
```
    Description copied from interface: Log
    
    Check whether this category is enabled for the info Level. See also Log.isDebugEnabled().
    
    Specified by:
    
    isInfoEnabled in interface Log
    
    Returns:
    
    boolean - true if this category is enabled for level info, false otherwise.
  - setLevel
```
public void setLevel(MyLogLevel level)
```
    Description copied from interface: Log
    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.
    Specified by:
    
    setLevel in interface Log
    
    Parameters:
    
    level - the new level
  - getLevel
```
public MyLogLevel getLevel()
```
    Description copied from interface: Log
    
    Returns the assigned MyLogLevel, if any, for this Category.
    
    Specified by:
    
    getLevel in interface Log
    
    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

Class NoLogger

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NoLogger

Method Detail

getNoLogger

getName

setName

trace

trace

info

info

debug

debug

warn

warn

error

error

fatal

fatal

test

test

log

log

isDebugEnabled

isInfoEnabled

setLevel

getLevel

shutdown