io.github.amyassist.amy.core.configuration

Interface ConfigurationManager

public interface ConfigurationManager

High level abstraction over different ConfigurationLoaders.

Author:

Leon Kiefer

Method Summary

Modifier and Type	Method and Description
Properties	getConfiguration(String configurationName) Get the configuration from the config dirs and don't use defaults.
Properties	getConfigurationWithDefaults(String configurationName) Get the configuration from the config dirs but fallback to the defaults.
Properties	getConfigurationWithDefaults(String configurationName, ClassLoader classLoader) Get the configuration from the config dirs but fallback to the defaults using the given classloader.

Method Detail

getConfiguration

@Nonnull
Properties getConfiguration(String configurationName)

Get the configuration from the config dirs and don't use defaults.

Parameters:

configurationName - the name of the configuration without the file ending .properties

Returns:

the properties

getConfigurationWithDefaults

@Nonnull
Properties getConfigurationWithDefaults(String configurationName)

Get the configuration from the config dirs but fallback to the defaults.

Parameters:

configurationName - the name of the configuration without the file ending .properties

Returns:

the configuration with the defaults from the default configuration

Throws:

ConfigurationNotFoundException - if the default configuration cloud not be found

getConfigurationWithDefaults

@Nonnull
Properties getConfigurationWithDefaults(String configurationName,
                                                  ClassLoader classLoader)

Get the configuration from the config dirs but fallback to the defaults using the given classloader.

Parameters:

configurationName - the name of the configuration without the file ending .properties

classLoader - the classLoader to use to find the default config

Returns:

the configuration with the defaults from the default configuration

Throws:

ConfigurationNotFoundException - if the default configuration cloud not be found