LogCaptor (log-captor 2.9.2 API)

java.lang.Object
- nl.altindag.log.LogCaptor

All Implemented Interfaces:: AutoCloseable

public final class LogCaptor
extends Object
implements AutoCloseable

Author:: Hakan Altindag

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFilter(ch.qos.logback.core.filter.Filter<ch.qos.logback.classic.spi.ILoggingEvent> filter)`
`void`	`clearLogs()`
`void`	`close()`
`void`	`disableConsoleOutput()` Disables the output of the log entries to the console.
`void`	`disableLogs()` Overrides the log level property of the target logger.
`void`	`enableConsoleOutput()` The output of the log entries to the console are enabled by default but can be re-enabled if they are disabled earlier by `disableConsoleOutput()`
`static LogCaptor`	`forClass(Class<?> clazz)` Captures log messages for the provided class
`static LogCaptor`	`forName(String name)` Captures log messages for the provided logger name
`static LogCaptor`	`forRoot()` Captures all log messages
`List<String>`	`getDebugLogs()`
`List<String>`	`getErrorLogs()`
`List<String>`	`getInfoLogs()`
`List<LogEvent>`	`getLogEvents()`
`List<String>`	`getLogs()`
`List<String>`	`getTraceLogs()`
`List<String>`	`getWarnLogs()`
`void`	`resetLogLevel()` Resets the log level of the target logger to the initial value which was available before changing it with `setLogLevelToInfo()`, `setLogLevelToDebug()` or with `setLogLevelToTrace()`
`void`	`setLogLevelToDebug()` Overrides the log level property of the target logger.
`void`	`setLogLevelToInfo()` Overrides the log level property of the target logger.
`void`	`setLogLevelToTrace()` Overrides the log level property of the target logger.

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

- Method Detail
  - forRoot
```
public static LogCaptor forRoot()
```
    Captures all log messages
    
    Returns:
    
    LogCaptor instance for the root logger
  - forClass
```
public static LogCaptor forClass(Class<?> clazz)
```
    Captures log messages for the provided class
    
    Parameters:
    
    clazz - Class for capturing
    
    Returns:
    
    LogCaptor instance for the provided class
  - forName
```
public static LogCaptor forName(String name)
```
    Captures log messages for the provided logger name
    
    Parameters:
    
    name - Logger name for capturing
    
    Returns:
    
    LogCaptor instance for the provided logger name
  - getLogs
```
public List<String> getLogs()
```
  - getInfoLogs
```
public List<String> getInfoLogs()
```
  - getDebugLogs
```
public List<String> getDebugLogs()
```
  - getWarnLogs
```
public List<String> getWarnLogs()
```
  - getErrorLogs
```
public List<String> getErrorLogs()
```
  - getTraceLogs
```
public List<String> getTraceLogs()
```
  - getLogEvents
```
public List<LogEvent> getLogEvents()
```
  - addFilter
```
public void addFilter(ch.qos.logback.core.filter.Filter<ch.qos.logback.classic.spi.ILoggingEvent> filter)
```
  - setLogLevelToInfo
```
public void setLogLevelToInfo()
```
    Overrides the log level property of the target logger. This may result that the overridden property of the target logger is still active even though a new instance of LogCaptor has been created. To roll-back to the initial state use: resetLogLevel() This option will implicitly include the following log levels: WARN and ERROR
  - setLogLevelToDebug
```
public void setLogLevelToDebug()
```
    Overrides the log level property of the target logger. This may result that the overridden property of the target logger is still active even though a new instance of LogCaptor has been created. To roll-back to the initial state use: resetLogLevel() This option will implicitly include the following log levels: INFO, WARN and ERROR
  - setLogLevelToTrace
```
public void setLogLevelToTrace()
```
    Overrides the log level property of the target logger. This may result that the overridden property of the target logger is still active even though a new instance of LogCaptor has been created. To roll-back to the initial state use: resetLogLevel() This option will implicitly include the following log levels: INFO, DEBUG, WARN and ERROR
  - disableLogs
```
public void disableLogs()
```
    Overrides the log level property of the target logger. This may result that the overridden property of the target logger is still active even though a new instance of LogCaptor has been created. To roll-back to the initial state use: resetLogLevel()
  - disableConsoleOutput
```
public void disableConsoleOutput()
```
    Disables the output of the log entries to the console. To revert this option use enableConsoleOutput(). LogCaptor will still be capturing the log entries.
  - enableConsoleOutput
```
public void enableConsoleOutput()
```
    The output of the log entries to the console are enabled by default but can be re-enabled if they are disabled earlier by disableConsoleOutput()
  - resetLogLevel
```
public void resetLogLevel()
```
    Resets the log level of the target logger to the initial value which was available before changing it with setLogLevelToInfo(), setLogLevelToDebug() or with setLogLevelToTrace()
  - clearLogs
```
public void clearLogs()
```
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable

Class LogCaptor

Method Summary

Methods inherited from class java.lang.Object

Method Detail

forRoot

forClass

forName

getLogs

getInfoLogs

getDebugLogs

getWarnLogs

getErrorLogs

getTraceLogs

getLogEvents

addFilter

setLogLevelToInfo

setLogLevelToDebug

setLogLevelToTrace

disableLogs

disableConsoleOutput

enableConsoleOutput

resetLogLevel

clearLogs

close