SudokuFX
Loading...
Searching...
No Matches
fr.softsf.sudokufx.config.MyLogbackConfig Class Reference

Configuration class for Logback logging framework. More...

+ Collaboration diagram for fr.softsf.sudokufx.config.MyLogbackConfig:

Public Member Functions

 MyLogbackConfig (IOsFolder iOsFolder)
 Constructor that initializes the logging configuration.
 
String getLogsFolderPath ()
 
void printLogEntryMessage ()
 Logs the ASCII logo (with app name and version), an optional optimization message at startup.
 

Package Functions

LoggerContext configureLogback ()
 Configures Logback using the specified configuration file.
 
void setLogBackPathForTests ()
 Sets an invalid logback configuration path for testing purposes.
 

Private Member Functions

void printLogStatus (final LoggerContext context)
 Prints the logger status to the log in case of errors or warnings.
 

Private Attributes

String logBackPath = CONFIG_LOGBACK_PATH.getPath()
 
final String logsFolderPath
 

Static Private Attributes

static final Logger LOG = LoggerFactory.getLogger(MyLogbackConfig.class)
 

Detailed Description

Configuration class for Logback logging framework.

This class sets up and configures Logback for the application.

Constructor & Destructor Documentation

◆ MyLogbackConfig()

fr.softsf.sudokufx.config.MyLogbackConfig.MyLogbackConfig ( IOsFolder iOsFolder)

Constructor that initializes the logging configuration.

Parameters
iOsFolderFactory for creating OS-specific folder paths.
+ Here is the call graph for this function:

Member Function Documentation

◆ configureLogback()

LoggerContext fr.softsf.sudokufx.config.MyLogbackConfig.configureLogback ( )
package

Configures Logback using the specified configuration file.

Returns
the configured LoggerContext
Exceptions
IllegalArgumentExceptionif the configuration resource cannot be found (inputStream is null)
LogbackConfigurationExceptionif an error occurs during Logback configuration
+ Here is the call graph for this function:

◆ getLogsFolderPath()

String fr.softsf.sudokufx.config.MyLogbackConfig.getLogsFolderPath ( )

◆ printLogEntryMessage()

void fr.softsf.sudokufx.config.MyLogbackConfig.printLogEntryMessage ( )

Logs the ASCII logo (with app name and version), an optional optimization message at startup.

◆ printLogStatus()

void fr.softsf.sudokufx.config.MyLogbackConfig.printLogStatus ( final LoggerContext context)
private

Prints the logger status to the log in case of errors or warnings.

Parameters
contextThe current logger context

◆ setLogBackPathForTests()

void fr.softsf.sudokufx.config.MyLogbackConfig.setLogBackPathForTests ( )
package

Sets an invalid logback configuration path for testing purposes.

This method should only be used in test scenarios.

Member Data Documentation

◆ LOG

final Logger fr.softsf.sudokufx.config.MyLogbackConfig.LOG = LoggerFactory.getLogger(MyLogbackConfig.class)
staticprivate

◆ logBackPath

String fr.softsf.sudokufx.config.MyLogbackConfig.logBackPath = CONFIG_LOGBACK_PATH.getPath()
private

◆ logsFolderPath

final String fr.softsf.sudokufx.config.MyLogbackConfig.logsFolderPath
private

The documentation for this class was generated from the following file: