com.cerner.beadledom.configuration

Class ConfigurationSourcesModuleBuilder

java.lang.Object

com.cerner.beadledom.configuration.ConfigurationSourcesModuleBuilder

public final class ConfigurationSourcesModuleBuilder
extends Object

A Builder class that builds a Guice module for binding multiple ConfigurationSources.

The Guice module that is built by this builder configures

• A Multibinder for ConfigurationSource

This builder can be used in multiple modules to bind multiple ConfigurationSource. Consumer must use the addSource(ConfigurationSource) builder method to build the list of configuration Sources.

The build() method creates a new anonymous Module that configures a Multibinder for the provided ConfigurationSource

Usage:

   public class MyModule extends AbstractModule {
      @Override
     protected void configure() {
        install(ConfigurationSourcesModuleBuilder.newBuilder()
          .addSource(source1)
          .addSource(source2)
          .addSource(source3)
          .build());
     }
   }
 

It is the responsibility of the consumer to build the configuration sources with appropriate priority (natural ordering). The priority or natural ordering of the ConfigurationSources is what is considered when loading the configurations from the corresponding sources instead of the order in which they are configured using this Builder.

Since:

2.1

Author:

Sundeep Paruvu

See Also:

BeadledomConfigurationModule

Method Summary

Modifier and Type	Method and Description
ConfigurationSourcesModuleBuilder	addSource(ConfigurationSource configurationSource) Adds the given configurationSource to the list.
com.google.inject.Module	build() Builds the ConfigurationSourcesModuleBuilder with the list of ConfigurationSources built using the #addSource(ConfigurationSource) builder method.
static ConfigurationSourcesModuleBuilder	newBuilder() Static Convenience method create an instance of ConfigurationSourcesModuleBuilder.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static ConfigurationSourcesModuleBuilder newBuilder()

Static Convenience method create an instance of ConfigurationSourcesModuleBuilder.

addSource

public ConfigurationSourcesModuleBuilder addSource(ConfigurationSource configurationSource)

Adds the given configurationSource to the list.

Parameters:

configurationSource - configuration source from which Configuration will be built.

Returns:

the current instance of the ConfigurationSourcesModuleBuilder.

build

public com.google.inject.Module build()

Builds the ConfigurationSourcesModuleBuilder with the list of ConfigurationSources built using the #addSource(ConfigurationSource) builder method.

Returns:

a Guice module that configures a Multibinder for ConfigurationSources