org.sdase.commons.server.dropwizard.bundles

Class ConfigurationValueSupplierBundle<C extends io.dropwizard.Configuration,R>

java.lang.Object

org.sdase.commons.server.dropwizard.bundles.ConfigurationValueSupplierBundle<C,R>

Type Parameters:

C - the configuration type

R - the type of the supplied value

All Implemented Interfaces:

io.dropwizard.ConfiguredBundle<C>

public class ConfigurationValueSupplierBundle<C extends io.dropwizard.Configuration,R>
extends java.lang.Object
implements io.dropwizard.ConfiguredBundle<C>

A bundle that creates a Supplier for a configuration value.

Having a supplier() knowing only the return type may be needed if the consumer should not know or can not know about the configuration class. Using a supplier without referencing the configuration class also makes it easier to replace a configured value with a value supplied by a service.

In most cases when bundles are initialized it is easier to use a Function<C extends Configuration, R> directly created from the configuration class as method reference: MyConfigClass::getValue

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigurationValueSupplierBundle.Builder<C extends io.dropwizard.Configuration,R>
static interface	ConfigurationValueSupplierBundle.FinalBuilder<C extends io.dropwizard.Configuration,R>
static interface	ConfigurationValueSupplierBundle.InitialBuilder

Method Summary

Modifier and Type	Method and Description
static ConfigurationValueSupplierBundle.InitialBuilder	builder()
void	initialize(io.dropwizard.setup.Bootstrap<?> bootstrap)
void	run(C configuration, io.dropwizard.setup.Environment environment)
java.util.function.Supplier<java.util.Optional<R>>	supplier()
java.util.function.Supplier<R>	valueSupplier()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ConfigurationValueSupplierBundle.InitialBuilder builder()

supplier

public java.util.function.Supplier<java.util.Optional<R>> supplier()

Returns:

a supplier providing the value of the configuration wrapped in an Optional. The supplier will fail with an IllegalStateException until ConfiguredBundle.run(Object, Environment) has been executed.

valueSupplier

public java.util.function.Supplier<R> valueSupplier()

Returns:

a supplier providing the value of the configuration. The supplier will fail with an IllegalStateException until ConfiguredBundle.run(Object, Environment) has been executed. The supplier may return null.

initialize

public void initialize(io.dropwizard.setup.Bootstrap<?> bootstrap)

Specified by:

initialize in interface io.dropwizard.ConfiguredBundle<C extends io.dropwizard.Configuration>

run

public void run(C configuration,
                io.dropwizard.setup.Environment environment)

Specified by:

run in interface io.dropwizard.ConfiguredBundle<C extends io.dropwizard.Configuration>