com.netflix.archaius.api.config

Interface CompositeConfig

All Superinterfaces:

Config, PropertySource

public interface CompositeConfig
extends Config

Config that is a composite of multiple configuration and as such doesn't track properties of its own. The composite does not merge the configurations but instead treats them as overrides so that a property existing in a configuration supersedes the same property in configuration based on some ordering. Implementations of this interface should specify and implement the override ordering.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CompositeConfig.CompositeVisitor<T>

Nested classes/interfaces inherited from interface com.netflix.archaius.api.Config

Config.Visitor<T>

Method Summary

Modifier and Type	Method and Description
boolean	addConfig(java.lang.String name, Config child) Add a named configuration.
void	addConfigs(java.util.LinkedHashMap<java.lang.String,Config> configs) Add a map of named configurations.
Config	getConfig(java.lang.String name) Look up a configuration by name
java.util.Collection<java.lang.String>	getConfigNames()
Config	removeConfig(java.lang.String name) Remove a named configuration.
void	replaceConfig(java.lang.String name, Config child) Replace the configuration with the specified name This will trigger an onConfigUpdated event.
void	replaceConfigs(java.util.LinkedHashMap<java.lang.String,Config> configs) Replace all configurations with the specified names in the map This will trigger an onConfigUpdated event.

Methods inherited from interface com.netflix.archaius.api.Config

accept, addListener, containsKey, get, get, get, get, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getByte, getByte, getDecoder, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getKeys, getKeys, getList, getList, getList, getLong, getLong, getPrefixedView, getPrivateView, getProperty, getPropertyUninstrumented, getRawProperty, getRawPropertyUninstrumented, getShort, getShort, getString, getString, getStrInterpolator, instrumentationEnabled, keys, recordUsage, removeListener, resolve, resolve, setDecoder, setStrInterpolator

Methods inherited from interface com.netflix.archaius.api.PropertySource

forEachProperty, forEachPropertyUninstrumented, getName, isEmpty

Method Detail

addConfig

boolean addConfig(java.lang.String name,
                  Config child)
           throws ConfigException

Add a named configuration. The newly added configuration takes precedence over all previously added configurations. Duplicate configurations are not allowed

This will trigger an onConfigAdded event.

Parameters:

name -

child -

Throws:

ConfigException

replaceConfig

void replaceConfig(java.lang.String name,
                   Config child)
            throws ConfigException

Replace the configuration with the specified name This will trigger an onConfigUpdated event.

Parameters:

name -

child -

Throws:

ConfigException

addConfigs

void addConfigs(java.util.LinkedHashMap<java.lang.String,Config> configs)
         throws ConfigException

Add a map of named configurations. The newly added configurations takes precedence over all previously added configurations. Duplicate configurations are not allowed

This will trigger an onConfigAdded event.

Parameters:

configs - a map of [configName, config]

Throws:

ConfigException

replaceConfigs

void replaceConfigs(java.util.LinkedHashMap<java.lang.String,Config> configs)
             throws ConfigException

Replace all configurations with the specified names in the map This will trigger an onConfigUpdated event.

Parameters:

configs - a map of [configName, config]

Throws:

ConfigException

removeConfig

Config removeConfig(java.lang.String name)

Remove a named configuration. This will trigger an onConfigRemoved event.

Parameters:

name -

Returns:

getConfig

Config getConfig(java.lang.String name)

Look up a configuration by name

Parameters:

name - the config name to look up

Returns:

the Config that matches the name, null otherwise

getConfigNames

java.util.Collection<java.lang.String> getConfigNames()

Returns:

a collection of all configNames