Package eu.svjatoslav.alyverkko_cli.configuration

Class ConfigurationHelper

java.lang.Object

eu.svjatoslav.alyverkko_cli.configuration.ConfigurationHelper

public class ConfigurationHelper
extends Object

Helper class for configuration file operations. Provides methods for loading configurations and determining the default configuration file path in the user's home directory.

Key functionality includes:

• Configuration file path resolution
• YAML deserialization
• Error handling for missing configurations

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CONFIG_FILE_PATH	The default path for the YAML config file, typically under the user's home directory.

Constructor Summary

Constructors

Constructor	Description
ConfigurationHelper()

Method Summary

Modifier and Type	Method	Description
static File	getConfigurationFile(eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOption configFileOption)	Returns the configuration file from the given option, or the default path if not present.
static Configuration	loadConfiguration(File configFile)	Loads the configuration from a given file, or from the default path if configFile is null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_CONFIG_FILE_PATH

public static final String DEFAULT_CONFIG_FILE_PATH

The default path for the YAML config file, typically under the user's home directory.

Constructor Details

ConfigurationHelper

public ConfigurationHelper()

Method Details

loadConfiguration

public static Configuration loadConfiguration(File configFile)
                                       throws IOException

Loads the configuration from a given file, or from the default path if configFile is null.

Parameters:

configFile - the file containing the YAML config; may be null.

Returns:

the Configuration object, or null if not found/invalid.

Throws:

IOException - if file I/O fails during reading.

getConfigurationFile

public static File getConfigurationFile(eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOption configFileOption)

Returns the configuration file from the given option, or the default path if not present.

Parameters:

configFileOption - the CLI option for the config file.

Returns:

the configuration file to load.