com.netflix.governator.configuration

Class CompositeConfigurationProvider

java.lang.Object

com.netflix.governator.configuration.CompositeConfigurationProvider

All Implemented Interfaces:

ConfigurationProvider

Direct Known Subclasses:

LifecycleConfigurationProviders

public class CompositeConfigurationProvider
extends java.lang.Object
implements ConfigurationProvider

A configuration provider that composites multiple providers. The first provider (in order) that has a configuration set (via has(ConfigurationKey) is used to return the configuration.

Constructor Summary

Constructors

Constructor and Description
CompositeConfigurationProvider(java.util.Collection<ConfigurationProvider> providers)
CompositeConfigurationProvider(ConfigurationProvider... providers)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ConfigurationProvider configurationProvider)
com.google.common.base.Supplier<java.lang.Boolean>	getBooleanSupplier(ConfigurationKey key, java.lang.Boolean defaultValue) Return the given configuration as a boolean.
com.google.common.base.Supplier<java.util.Date>	getDateSupplier(ConfigurationKey key, java.util.Date defaultValue) Return the given configuration as a date.
com.google.common.base.Supplier<java.lang.Double>	getDoubleSupplier(ConfigurationKey key, java.lang.Double defaultValue) Return the given configuration as a double.
com.google.common.base.Supplier<java.lang.Integer>	getIntegerSupplier(ConfigurationKey key, java.lang.Integer defaultValue) Return the given configuration as an integer.
com.google.common.base.Supplier<java.lang.Long>	getLongSupplier(ConfigurationKey key, java.lang.Long defaultValue) Return the given configuration as a long.
<T> com.google.common.base.Supplier<T>	getObjectSupplier(ConfigurationKey key, T defaultValue, java.lang.Class<T> objectType) Return the given configuration as an object of the given type.
com.google.common.base.Supplier<java.lang.String>	getStringSupplier(ConfigurationKey key, java.lang.String defaultValue) Return the given configuration as a string.
boolean	has(ConfigurationKey key) Return true if there is a configuration value set for the given key

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeConfigurationProvider

public CompositeConfigurationProvider(ConfigurationProvider... providers)

Parameters:

providers - ordered providers

CompositeConfigurationProvider

public CompositeConfigurationProvider(java.util.Collection<ConfigurationProvider> providers)

Parameters:

providers - ordered providers

Method Detail

add

public void add(ConfigurationProvider configurationProvider)

has

public boolean has(ConfigurationKey key)

Description copied from interface: ConfigurationProvider

Return true if there is a configuration value set for the given key

Specified by:

has in interface ConfigurationProvider

Parameters:

key - configuration key

Returns:

true/false

getBooleanSupplier

public com.google.common.base.Supplier<java.lang.Boolean> getBooleanSupplier(ConfigurationKey key,
                                                                    java.lang.Boolean defaultValue)

Description copied from interface: ConfigurationProvider

Return the given configuration as a boolean. Use this when the configuration value is expected to change at run time.

Specified by:

getBooleanSupplier in interface ConfigurationProvider

Parameters:

key - configuration key

Returns:

value

getIntegerSupplier

public com.google.common.base.Supplier<java.lang.Integer> getIntegerSupplier(ConfigurationKey key,
                                                                    java.lang.Integer defaultValue)

Description copied from interface: ConfigurationProvider

Return the given configuration as an integer. Use this when the configuration value is expected to change at run time.

Specified by:

getIntegerSupplier in interface ConfigurationProvider

Parameters:

key - configuration key

Returns:

value

getLongSupplier

public com.google.common.base.Supplier<java.lang.Long> getLongSupplier(ConfigurationKey key,
                                                              java.lang.Long defaultValue)

Description copied from interface: ConfigurationProvider

Return the given configuration as a long. Use this when the configuration value is expected to change at run time.

Specified by:

getLongSupplier in interface ConfigurationProvider

Parameters:

key - configuration key

Returns:

value

getDoubleSupplier

public com.google.common.base.Supplier<java.lang.Double> getDoubleSupplier(ConfigurationKey key,
                                                                  java.lang.Double defaultValue)

Description copied from interface: ConfigurationProvider

Return the given configuration as a double. Use this when the configuration value is expected to change at run time.

Specified by:

getDoubleSupplier in interface ConfigurationProvider

Parameters:

key - configuration key

Returns:

value

getStringSupplier

public com.google.common.base.Supplier<java.lang.String> getStringSupplier(ConfigurationKey key,
                                                                  java.lang.String defaultValue)

Description copied from interface: ConfigurationProvider

Return the given configuration as a string. Use this when the configuration value is expected to change at run time.

Specified by:

getStringSupplier in interface ConfigurationProvider

Parameters:

key - configuration key

Returns:

value

getDateSupplier

public com.google.common.base.Supplier<java.util.Date> getDateSupplier(ConfigurationKey key,
                                                              java.util.Date defaultValue)

Description copied from interface: ConfigurationProvider

Return the given configuration as a date. Use this when the configuration value is expected to change at run time.

Specified by:

getDateSupplier in interface ConfigurationProvider

Parameters:

key - configuration key

Returns:

value

getObjectSupplier

public <T> com.google.common.base.Supplier<T> getObjectSupplier(ConfigurationKey key,
                                                       T defaultValue,
                                                       java.lang.Class<T> objectType)

Description copied from interface: ConfigurationProvider

Return the given configuration as an object of the given type.

Specified by:

getObjectSupplier in interface ConfigurationProvider

Type Parameters:

T - type of the configuration to return

Parameters:

key - configuration key

defaultValue - value to return when key is not found

objectType - Class of the configuration to return

Returns:

the object for this configuration.