net.morimekta.providence.config

Class OverrideConfigSupplier<Message extends PMessage<Message,Field>,Field extends PField>

java.lang.Object

net.morimekta.providence.config.impl.UpdatingConfigSupplier<Message,Field>

net.morimekta.providence.config.OverrideConfigSupplier<Message,Field>

All Implemented Interfaces:

Supplier<Message>, ConfigSupplier<Message,Field>

public class OverrideConfigSupplier<Message extends PMessage<Message,Field>,Field extends PField>
extends UpdatingConfigSupplier<Message,Field>

A supplier of a providence message config based on a parent config (supplier) and a map of value overrides. Handy for use with argument parsers overrides, system property overrides or similar.

     Supplier<Service> supplier = new OverrideConfigSupplier<>(
             baseServiceConfig,
             ImmutableMap.of(
                 "db.username", "root",
                 "jdbc.driver", "com.oracle.jdbc.Driver"
             ));
 

Constructor Summary

Constructors

Constructor and Description
OverrideConfigSupplier(Clock clock, ConfigSupplier<Message,Field> parent, Map<String,String> overrides, boolean strict) Create a config that wraps a providence message instance.
OverrideConfigSupplier(ConfigSupplier<Message,Field> parent, Map<String,String> overrides) Create a config that wraps a providence message instance.
OverrideConfigSupplier(ConfigSupplier<Message,Field> parent, Map<String,String> overrides, boolean strict) Create a config that wraps a providence message instance.
OverrideConfigSupplier(ConfigSupplier<Message,Field> parent, Properties overrides) Create a config that wraps a providence message instance.

Method Summary

Modifier and Type	Method and Description
String	getName() Get a simple descriptive name for this config supplier.
String	toString()

Methods inherited from class net.morimekta.providence.config.impl.UpdatingConfigSupplier

addListener, configTimestamp, get, removeListener, set

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.morimekta.providence.config.ConfigSupplier

snapshot

Constructor Detail

OverrideConfigSupplier

public OverrideConfigSupplier(@Nonnull
                              ConfigSupplier<Message,Field> parent,
                              @Nonnull
                              Properties overrides)
                       throws ProvidenceConfigException

Create a config that wraps a providence message instance. This message will be exposed without any key prefix. Note that reading from properties are never strict.

Parameters:

parent - The parent message to override values of.

overrides - The message override values.

Throws:

ProvidenceConfigException - If message overriding failed

OverrideConfigSupplier

public OverrideConfigSupplier(@Nonnull
                              ConfigSupplier<Message,Field> parent,
                              @Nonnull
                              Map<String,String> overrides)
                       throws ProvidenceConfigException

Create a config that wraps a providence message instance. This message will be exposed without any key prefix.

Parameters:

parent - The parent message to override values of.

overrides - The message override values.

Throws:

ProvidenceConfigException - If message overriding failed

OverrideConfigSupplier

public OverrideConfigSupplier(@Nonnull
                              ConfigSupplier<Message,Field> parent,
                              @Nonnull
                              Map<String,String> overrides,
                              boolean strict)
                       throws ProvidenceConfigException

Create a config that wraps a providence message instance. This message will be exposed without any key prefix.

Parameters:

parent - The parent message to override values of.

overrides - The message override values.

strict - If config should be read strictly.

Throws:

ProvidenceConfigException - If message overriding failed

OverrideConfigSupplier

public OverrideConfigSupplier(@Nonnull
                              Clock clock,
                              @Nonnull
                              ConfigSupplier<Message,Field> parent,
                              @Nonnull
                              Map<String,String> overrides,
                              boolean strict)
                       throws ProvidenceConfigException

Create a config that wraps a providence message instance. This message will be exposed without any key prefix.

Parameters:

clock - Clock used to time the updates.

parent - The parent message to override values of.

overrides - The message override values.

strict - If config should be read strictly.

Throws:

ProvidenceConfigException - If message overriding failed

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Description copied from interface: ConfigSupplier

Get a simple descriptive name for this config supplier.

Returns:

The supplier name.