Module dev.orne.config
Package dev.orne.config

Interface ConfigProvider

All Known Implementing Classes:
ConfigProviderImpl
@API(status=STABLE, since="1.0") public interface ConfigProvider
Generic interface for Config providers.
Since:
0.1
Version:
1.0, 2019-07, 1.1, 2025-07
Author:
(w) Iker Hernaez

  • Method Details

    • builder

      static ConfigProviderBuilder builder(Config defaultConfig)
      Creates a new ConfigProviderBuilder instance using the specified default configuration.
      Parameters:
      defaultConfig - The default configuration instance.
      Returns:
      A new ConfigProviderBuilder instance

    • getDefaultConfig

      Config getDefaultConfig()
      Returns the default Config instance.
      Returns:
      The default Config instance

    • getConfig

      Optional<Config> getConfig(Class<? extends Config> type)
      Returns the registered Config for the specified type, if any.
      Parameters:
      type - The configuration type.
      Returns:
      The registered Config.

    • selectConfig

      @Nullable Config selectConfig(@Nullable PreferredConfig preferences)
      Returns a suitable Config instance for the configuration preferences passed as argument.
      Parameters:
      preferences - The configuration preferences.
      Returns:
      The selected Config instance, or null if no one is suitable