com.netflix.governator.configuration

Interface ConfigurationProvider

All Known Implementing Classes:

AbstractObjectConfigurationProvider, CompositeConfigurationProvider, DefaultConfigurationProvider, LifecycleConfigurationProviders, PropertiesConfigurationProvider, SystemConfigurationProvider

public interface ConfigurationProvider

Abstraction for get configuration values to use for fields annotated with Configuration

Method Summary

Methods

Modifier and Type	Method and Description
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

Method Detail

has

boolean has(ConfigurationKey key)

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

Parameters:

key - configuration key

Returns:

true/false

getBooleanSupplier

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

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

Parameters:

key - configuration key

Returns:

value

getIntegerSupplier

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

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

Parameters:

key - configuration key

Returns:

value

getLongSupplier

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

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

Parameters:

key - configuration key

Returns:

value

getDoubleSupplier

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

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

Parameters:

key - configuration key

Returns:

value

getStringSupplier

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

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

Parameters:

key - configuration key

Returns:

value

getDateSupplier

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

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

Parameters:

key - configuration key

Returns:

value

getObjectSupplier

<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.

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.