Package com.github.cafapi.common.api

Interface ConfigurationSource

All Known Subinterfaces:
ManagedConfigurationSource
All Known Implementing Classes:
CafConfigurationSource, FileConfigurationSource
public interface ConfigurationSource
A ConfigurationSource is intended to provide an implementation-agnostic method of retrieving application-specific configuration.

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> T
    getConfiguration(Class<T> configClass)
    Acquire a configuration class.

  • Method Details

    • getConfiguration

      <T> T getConfiguration(Class<T> configClass) throws ConfigurationException
      Acquire a configuration class.
      Type Parameters:
      T - the class that represents your configuration
      Parameters:
      configClass - the class that represents your configuration
      Returns:
      the configuration class requested, if it can be deserialised
      Throws:
      ConfigurationException - if the configuration class cannot be acquired or deserialised