Log

java.lang.Object
- biolockj.Log

```
public class Log
extends Object
```
Simple Logging Facade for Java (SLF4J) implementation using Log4J
Log4J Configuration: log4j.properties
Every Java class that prints to the Java log file, will do so by calling:
- out(Class).out(Class).debug( logMessage )
- out(Class).out(Class).info( logMessage )
- out(Class).out(Class).warn( logMessage )
- out(Class).out(Class).error( logMessage, exception )

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEBUG` DEBUG log message type
`protected static String`	`DEFAULT_FORMAT` Standard BioLockJ log format includes date, time, severity type, and calling class before the msg.
`protected static String`	`DIRECT_FORMAT` Direct BioLockJ log prefix includes only the msg.
`static String`	`ERROR` ERROR log message type
`static String`	`INFO` INFO log message type
`protected static String`	`LOG_APPEND` Set in `initialize(String)` to true only if executing pipeline restart. Used by log4j.properties log4j.appender.file.Append=${LOG_APPEND}
`protected static String`	`LOG_FILE` Set in `initialize(String)` to file path of pipeline Java log file Used by log4j.properties log4j.appender.file.File=${LOG_FILE}
`static String`	`WARN` WARN log message type

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`debug(Class<?> loggingClass, String msg)` Print log level DEBUG message. Do not print `MetaUtil` debug since these will always print since the Logger isn't initialized yet and logMesseges will print them as INFO after Log file initializes.
`static boolean`	`doDebug()` Return TRUE if = DEBUG.
`static void`	`enableLogs(boolean enable)` Boolean toggle to enable/disable all log messages
`static void`	`error(Class<?> myClass, String msg)` Print log level ERROR message without exception stacktrace
`static void`	`error(Class<?> myClass, String msg, Exception exception)` Print log level ERROR message.
`static File`	`getFile()` Returns the log file.
`static List<String[]>`	`getMsgs()` Get the logMesseges created prior to creating the actual `LOG_FILE`
`static void`	`info(Class<?> myClass, String msg)` Print log level INFO message.
`static void`	`initialize(String name)` Called by `BioLockJ.main()` after `Config` is initialized.
`protected static void`	`logConfig()` Prints `Config` properties to the Java log file.
`protected static void`	`logWelcomeMsg()` Print welcome message. Message includes BioLockJ version `BioLockJUtil.getVersion()`, lab citation, and freeware blurb.
`static org.slf4j.Logger`	`out(Class<?> callingClass)` Returns the Logger for the callingClass.
`protected static String`	`validateLogLevel()` Validate log level is configured to one of the valid Log4J options: DEBUG, INFO, WARN, ERROR
`static void`	`warn(Class<?> myClass, String msg)` Print log level WARN message.

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

- Field Detail
  - DEBUG
```
public static String DEBUG
```
    DEBUG log message type
  - ERROR
```
public static String ERROR
```
    ERROR log message type
  - INFO
```
public static String INFO
```
    INFO log message type
  - WARN
```
public static String WARN
```
    WARN log message type
  - DEFAULT_FORMAT
```
protected static final String DEFAULT_FORMAT
```
    Standard BioLockJ log format includes date, time, severity type, and calling class before the msg. Example: 2018-05-27 19:53:04 INFO MetaUtil:
    
    See Also:
    
    Constant Field Values
  - DIRECT_FORMAT
```
protected static final String DIRECT_FORMAT
```
    Direct BioLockJ log prefix includes only the msg. Example: 2018-05-27 19:53:04 INFO MetaUtil:
    
    See Also:
    
    Constant Field Values
  - LOG_APPEND
```
protected static final String LOG_APPEND
```
    Set in initialize(String) to true only if executing pipeline restart.
    Used by log4j.properties
    log4j.appender.file.Append=${LOG_APPEND}
    
    See Also:
    
    Constant Field Values
  - LOG_FILE
```
protected static final String LOG_FILE
```
    Set in initialize(String) to file path of pipeline Java log file
    Used by log4j.properties
    log4j.appender.file.File=${LOG_FILE}
    
    See Also:
    
    Constant Field Values
- Method Detail
  - debug
```
public static void debug(Class<?> loggingClass,
                         String msg)
```
    Print log level DEBUG message.
    Do not print MetaUtil debug since these will always print since the Logger isn't initialized yet and logMesseges will print them as INFO after Log file initializes.
    
    Parameters:
    
    loggingClass - Logging class
    
    msg - Message to log
  - doDebug
```
public static boolean doDebug()
                       throws Exception
```
    Return TRUE if = DEBUG.
    
    Returns:
    
    TRUE if DEBUG
    
    Throws:
    
    Exception - if errors occur
  - enableLogs
```
public static void enableLogs(boolean enable)
```
    Boolean toggle to enable/disable all log messages
    
    Parameters:
    
    enable - boolean
  - error
```
public static void error(Class<?> myClass,
                         String msg)
```
    Print log level ERROR message without exception stacktrace
    
    Parameters:
    
    myClass - Logging class
    
    msg - Message to log
  - error
```
public static void error(Class<?> myClass,
                         String msg,
                         Exception exception)
```
    Print log level ERROR message.
    
    Parameters:
    
    myClass - Logging class
    
    msg - Message to log
    
    exception - Cause of the error
  - getFile
```
public static File getFile()
```
    Returns the log file.
    
    Returns:
    
    File logFile
  - getMsgs
```
public static List<String[]> getMsgs()
```
    Get the logMesseges created prior to creating the actual LOG_FILE
    
    Returns:
    
    logMesseges
  - info
```
public static void info(Class<?> myClass,
                        String msg)
```
    Print log level INFO message.
    
    Parameters:
    
    myClass - Logging class
    
    msg - Message to log
  - initialize
```
public static void initialize(String name)
                       throws Exception
```
    Called by BioLockJ.main() after Config is initialized. Create Java Log4J log file in Config."internal.pipelineDir", named after the project.
    - Set and store LOG_FILE and LOG_APPEND in System properties to be used by log4j.properties
    - Print cached messages generated prior to Log file initialization to log file as INFO
    - Print Config property values to log file as INFO
    Parameters:
    
    name - Name of the log file
    
    Throws:
    
    Exception - if unable to create the log file or print Config properties
  - out
```
public static org.slf4j.Logger out(Class<?> callingClass)
```
    Returns the Logger for the callingClass. Each class has its own Logger since the callingClass name can be appended to the log file without impacting performance.
    
    Parameters:
    
    callingClass - Java class in need of Logger
    
    Returns:
    
    Logger for callingClass
  - warn
```
public static void warn(Class<?> myClass,
                        String msg)
```
    Print log level WARN message.
    
    Parameters:
    
    myClass - Logging class
    
    msg - Message to log
  - logConfig
```
protected static void logConfig()
```
    Prints Config properties to the Java log file.
  - logWelcomeMsg
```
protected static void logWelcomeMsg()
                             throws Exception
```
    Print welcome message.
    Message includes BioLockJ version BioLockJUtil.getVersion(), lab citation, and freeware blurb.
    
    Throws:
    
    Exception - if errors occur
  - validateLogLevel
```
protected static String validateLogLevel()
                                  throws Exception
```
    Validate log level is configured to one of the valid Log4J options: DEBUG, INFO, WARN, ERROR
    
    Returns:
    
    valid logLevel (DEBUG, INFO, WARN, ERROR)
    
    Throws:
    
    Exception - if Config. parameter is missing or invalid

Class Log

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEBUG

ERROR

INFO

WARN

DEFAULT_FORMAT

DIRECT_FORMAT

LOG_APPEND

LOG_FILE

Method Detail

debug

doDebug

enableLogs

error

error

getFile

getMsgs

info

initialize

out

warn

logConfig

logWelcomeMsg

validateLogLevel