DasLogger (site-test 0.3.5-SNAPSHOT API)

java.lang.Object
- us.johnmeyer.utilities.DasLogger

public final class DasLogger
extends Object

Provides logging.

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`CLASS` Name of this class.
`private static String`	`CONFIG_ENTRY` Formatter string for building configuration entry for log.
`private static String`	`FILE_NAME` Log file name das.log.
`private static String`	`GET_INFORMATION_TEMPLATE` Test information (a la toString) template for test default.
`private static Handler`	`handler` Logging handler.
`private static int`	`INDEX_FOR_FORMATTER_HANDLER` Array index (0) of log handler to check formatter.
`private static Boolean`	`IS_APPEND` Directive to append to end of file.
`private static Boolean`	`isConfigurationLogged` Has configuration been logged?
`private static Boolean`	`isLoggingInitialized` Is logging initialized?
`private static Level`	`LOG_LEVEL` Logger directive Level.ALL to put everything to log.
`private static Logger`	`logger` Logger.

Constructor Summary

Constructors
Modifier Constructor and Description

private DasLogger()
Private constructor to prevent instantiation of public utility class.

Constructors
Modifier	Constructor and Description
`private`	`DasLogger()` Private constructor to prevent instantiation of public utility class.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`closeLog()` Close the log.
`static void`	`flush()` Flushes any pending log writes.
`static String`	`getFileName()` Returns log file name.
`static String`	`getFormatterName()` Return class name of formatter in use.
`static Integer`	`getHandlerCount()` Returns count of log handlers.
`static String`	`getInformation()` Returns information about logger class-level configuration.
`static String`	`getLog()` Flushes cached data to disk and returns entire log.
`static String`	`getLogFilename()` Returns name of log file.
`static Logger`	`getLogger()` Returns internal logger.
`static void`	`initializeLogging()` Initializes logging.
`static Boolean`	`isAppend()` Returns append setting on log.
`static Boolean`	`isInitialized()` Returns whether logging is intialized.
`static void`	`logConfig(String configInfo)` Logs configuration data that can be used for testing private constants etc.
`static void`	`logEntrance(String className, String method)` Logs method kick-off sans parameters.
`static void`	`logEntrance(String className, String method, Object[] logEntryContent)` Logs method kick-off, depicting an array of pararmeters.
`static void`	`logException(String className, String method, Throwable logEntryContent)` Logs exception.
`static void`	`logExit(String className, String method)` Logs method exit.
`static void`	`logExit(String className, String method, Object logEntryContent)` Logs method exit, depicting a return value.
`static void`	`logFine(String logMessage)` Logs fine level entry.
`static String`	`recentLogActivity(int beforeLength)` Returns log activity that occured after a point in time.

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

- Field Detail
  - CLASS
```
private static final String CLASS
```
    Name of this class.
    
    See Also:
    
    Constant Field Values
  - GET_INFORMATION_TEMPLATE
```
private static final String GET_INFORMATION_TEMPLATE
```
    Test information (a la toString) template for test default. (toString was not an option on a static class.)
```
       = = "Dev-A-Station Logger %s\n"
       + "+ "==============================================\n"
       + "+ "|Log Level: %s"
       + "+ "|File Name: %s"
       + "+ "|Append: %s|\n
       + "+ "----------------------------------------------\n"
       + "\n";
 
```
    See Also:
    
    Constant Field Values
  - CONFIG_ENTRY
```
private static final String CONFIG_ENTRY
```
    Formatter string for building configuration entry for log.
    
    See Also:
    
    Constant Field Values
  - LOG_LEVEL
```
private static final Level LOG_LEVEL
```
    Logger directive Level.ALL to put everything to log. This is from enum Level.
  - FILE_NAME
```
private static final String FILE_NAME
```
    Log file name das.log.
    
    See Also:
    
    Constant Field Values
  - logger
```
private static Logger logger
```
    Logger.
  - IS_APPEND
```
private static final Boolean IS_APPEND
```
    Directive to append to end of file.
  - isLoggingInitialized
```
private static Boolean isLoggingInitialized
```
    Is logging initialized?
  - isConfigurationLogged
```
private static Boolean isConfigurationLogged
```
    Has configuration been logged?
  - handler
```
private static Handler handler
```
    Logging handler.
  - INDEX_FOR_FORMATTER_HANDLER
```
private static final int INDEX_FOR_FORMATTER_HANDLER
```
    Array index (0) of log handler to check formatter. (Loggers can have multiple handlers; this is the one we are interested in.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DasLogger
```
private DasLogger()
```
    Private constructor to prevent instantiation of public utility class.
- Method Detail
  - getFileName
```
public static String getFileName()
```
    Returns log file name.
    
    Returns:
    
    filename for "anonymous" log
  - isAppend
```
public static Boolean isAppend()
```
    Returns append setting on log.
    
    Returns:
    
    true if to append.
  - isInitialized
```
public static Boolean isInitialized()
```
    Returns whether logging is intialized.
    
    Returns:
    
    true if initialized
  - getLogger
```
public static Logger getLogger()
```
    Returns internal logger. To this, prefer using wrapper functions such as logFine, longExit, logException etc to honor LoD design pattern.
    
    Returns:
    
    Anonymous logger.
  - initializeLogging
```
public static void initializeLogging()
```
    Initializes logging. Note this is called automatically by most DasLogger methods to avoid code repitition in client code.
  - flush
```
public static void flush()
```
    Flushes any pending log writes.
  - closeLog
```
public static void closeLog()
```
    Close the log.
  - getInformation
```
public static String getInformation()
```
    Returns information about logger class-level configuration. (Static replacement for toString().
    
    Returns:
    
    Information about log.
  - getHandlerCount
```
public static Integer getHandlerCount()
```
    Returns count of log handlers.
    
    Returns:
    
    number of handlers assigned to logger
  - getFormatterName
```
public static String getFormatterName()
```
    Return class name of formatter in use.
    
    Returns:
    
    class name of formatter
  - getLogFilename
```
public static String getLogFilename()
```
    Returns name of log file.
    
    Returns:
    
    pattern of log file name.
  - getLog
```
public static String getLog()
```
    Flushes cached data to disk and returns entire log.
    
    Returns:
    
    log for this (and possibly previous) tests.
  - recentLogActivity
```
public static String recentLogActivity(int beforeLength)
```
    Returns log activity that occured after a point in time. The calling function needs to check log length before performing the activity of interest. So to use this, get the log beforehand, and then pass the string length of the beforehand log to this method.
    
    Parameters:
    
    beforeLength - length of log before caller performed activity of interest
    
    Returns:
    
    data written to log after activity of interest
    
    Throws:
    
    IllegalArgumentException - if length passed is negative or exceeds length of current log.
  - logConfig
```
public static void logConfig(String configInfo)
```
    Logs configuration data that can be used for testing private constants etc.
    
    Parameters:
    
    configInfo - Configuration information.
  - logEntrance
```
public static void logEntrance(String className,
                               String method,
                               Object[] logEntryContent)
```
    Logs method kick-off, depicting an array of pararmeters.
    
    Parameters:
    
    className - Name of class invoking log.
    
    method - Name of method logging method entry.
    
    logEntryContent - Content to depict in log; can include parameters.
  - logEntrance
```
public static void logEntrance(String className,
                               String method)
```
    Logs method kick-off sans parameters.
    
    Parameters:
    
    className - Name of class invoking log.
    
    method - Name of method logging method entry.
  - logExit
```
public static void logExit(String className,
                           String method)
```
    Logs method exit.
    
    Parameters:
    
    method - method logging exit
    
    className - class invoking log
  - logExit
```
public static void logExit(String className,
                           String method,
                           Object logEntryContent)
```
    Logs method exit, depicting a return value.
    
    Parameters:
    
    logEntryContent - object (return value) to depict in log entry
    
    method - method logging exit
    
    className - class invoking log
  - logException
```
public static void logException(String className,
                                String method,
                                Throwable logEntryContent)
```
    Logs exception.
    
    Parameters:
    
    className - class invoking log
    
    method - method logging the exception
    
    logEntryContent - exception to depict in log entry
  - logFine
```
public static void logFine(String logMessage)
```
    Logs fine level entry.
    
    Parameters:
    
    logMessage - Message to be logged as fine.

Class DasLogger

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS

GET_INFORMATION_TEMPLATE

CONFIG_ENTRY

LOG_LEVEL

FILE_NAME

logger

IS_APPEND

isLoggingInitialized

isConfigurationLogged

handler

INDEX_FOR_FORMATTER_HANDLER

Constructor Detail

DasLogger

Method Detail

getFileName

isAppend

isInitialized

getLogger

initializeLogging

flush

closeLog

getInformation

getHandlerCount

getFormatterName

getLogFilename

getLog

recentLogActivity

logConfig

logEntrance

logEntrance

logExit

logExit

logException

logFine