com.netflix.archaius.api

Interface Config

All Superinterfaces:

PropertySource

All Known Subinterfaces:

CompositeConfig, LayeredConfig, SettableConfig

public interface Config
extends PropertySource

Core API for reading a configuration. The API is read only.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Config.Visitor<T> Interface for a visitor visiting all key, value pairs.

Method Summary

Modifier and Type	Method and Description
<T> T	accept(Config.Visitor<T> visitor) Visitor pattern
void	addListener(ConfigListener listener) Register a listener that will receive a call for each property that is added, removed or updated.
boolean	containsKey(java.lang.String key)
<T> T	get(java.lang.Class<T> type, java.lang.String key) Get the property from the Decoder.
<T> T	get(java.lang.Class<T> type, java.lang.String key, T defaultValue) Get the property from the Decoder.
<T> T	get(java.lang.reflect.Type type, java.lang.String key) Get the property from the Decoder.
<T> T	get(java.lang.reflect.Type type, java.lang.String key, T defaultValue) Get the property from the Decoder.
java.math.BigDecimal	getBigDecimal(java.lang.String key)
java.math.BigDecimal	getBigDecimal(java.lang.String key, java.math.BigDecimal defaultValue)
java.math.BigInteger	getBigInteger(java.lang.String key)
java.math.BigInteger	getBigInteger(java.lang.String key, java.math.BigInteger defaultValue)
java.lang.Boolean	getBoolean(java.lang.String key)
java.lang.Boolean	getBoolean(java.lang.String key, java.lang.Boolean defaultValue)
java.lang.Byte	getByte(java.lang.String key)
java.lang.Byte	getByte(java.lang.String key, java.lang.Byte defaultValue)
Decoder	getDecoder()
java.lang.Double	getDouble(java.lang.String key)
java.lang.Double	getDouble(java.lang.String key, java.lang.Double defaultValue)
java.lang.Float	getFloat(java.lang.String key)
java.lang.Float	getFloat(java.lang.String key, java.lang.Float defaultValue)
java.lang.Integer	getInteger(java.lang.String key)
java.lang.Integer	getInteger(java.lang.String key, java.lang.Integer defaultValue)
java.util.Iterator<java.lang.String>	getKeys() Deprecated. Use keys() instead.
java.util.Iterator<java.lang.String>	getKeys(java.lang.String prefix)
java.util.List<?>	getList(java.lang.String key) Get the property as a list.
<T> java.util.List<T>	getList(java.lang.String key, java.lang.Class<T> type)
java.util.List<?>	getList(java.lang.String key, java.util.List<?> defaultValue)
java.lang.Long	getLong(java.lang.String key) Parse the property as a long.
java.lang.Long	getLong(java.lang.String key, java.lang.Long defaultValue) Parse the property as a long but return a default if no property defined or the property cannot be parsed successfully.
Config	getPrefixedView(java.lang.String prefix)
Config	getPrivateView()
default java.util.Optional<java.lang.Object>	getProperty(java.lang.String key) Get the raw property value.
default java.util.Optional<java.lang.Object>	getPropertyUninstrumented(java.lang.String key) Get the raw property value, but do not record any usage data.
java.lang.Object	getRawProperty(java.lang.String key) Return the raw, un-interpolated, object associated with a key.
default java.lang.Object	getRawPropertyUninstrumented(java.lang.String key) Returns the raw object associated with a key, but without reporting on its usage.
java.lang.Short	getShort(java.lang.String key)
java.lang.Short	getShort(java.lang.String key, java.lang.Short defaultValue)
java.lang.String	getString(java.lang.String key)
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue)
StrInterpolator	getStrInterpolator()
default boolean	instrumentationEnabled() Returns whether a config is recording usage on the standard property endpoints.
default java.lang.Iterable<java.lang.String>	keys() Returns an unmodifiable Iterable of all property names owned by this config.
default void	recordUsage(PropertyDetails propertyDetails)
void	removeListener(ConfigListener listener) Remove a previously registered listener.
default java.lang.String	resolve(java.lang.String value)
default <T> T	resolve(java.lang.String value, java.lang.Class<T> type)
void	setDecoder(Decoder decoder) Set the Decoder used by get() to parse any type.
void	setStrInterpolator(StrInterpolator interpolator) Set the interpolator to be used.

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

forEachProperty, forEachPropertyUninstrumented, getName, isEmpty

Method Detail

addListener

void addListener(ConfigListener listener)

Register a listener that will receive a call for each property that is added, removed or updated. It is recommended that the callbacks be invoked only after a full refresh of the properties to ensure they are in a consistent state.

Parameters:

listener -

removeListener

void removeListener(ConfigListener listener)

Remove a previously registered listener.

Parameters:

listener -

getRawProperty

java.lang.Object getRawProperty(java.lang.String key)

Return the raw, un-interpolated, object associated with a key.

Parameters:

key -

getRawPropertyUninstrumented

default java.lang.Object getRawPropertyUninstrumented(java.lang.String key)

Returns the raw object associated with a key, but without reporting on its usage. Only relevant for configs that support property instrumentation.

Parameters:

key -

getProperty

default java.util.Optional<java.lang.Object> getProperty(java.lang.String key)

Description copied from interface: PropertySource

Get the raw property value. No interpolation or other modification is done to the property.

Specified by:

getProperty in interface PropertySource

getPropertyUninstrumented

default java.util.Optional<java.lang.Object> getPropertyUninstrumented(java.lang.String key)

Description copied from interface: PropertySource

Get the raw property value, but do not record any usage data.

Specified by:

getPropertyUninstrumented in interface PropertySource

recordUsage

default void recordUsage(PropertyDetails propertyDetails)

instrumentationEnabled

default boolean instrumentationEnabled()

Returns whether a config is recording usage on the standard property endpoints.

getLong

java.lang.Long getLong(java.lang.String key)

Parse the property as a long.

Parameters:

key -

getLong

java.lang.Long getLong(java.lang.String key,
                       java.lang.Long defaultValue)

Parse the property as a long but return a default if no property defined or the property cannot be parsed successfully.

Parameters:

key -

defaultValue -

Returns:

getString

java.lang.String getString(java.lang.String key)

getString

java.lang.String getString(java.lang.String key,
                           java.lang.String defaultValue)

getDouble

java.lang.Double getDouble(java.lang.String key)

getDouble

java.lang.Double getDouble(java.lang.String key,
                           java.lang.Double defaultValue)

getInteger

java.lang.Integer getInteger(java.lang.String key)

getInteger

java.lang.Integer getInteger(java.lang.String key,
                             java.lang.Integer defaultValue)

getBoolean

java.lang.Boolean getBoolean(java.lang.String key)

getBoolean

java.lang.Boolean getBoolean(java.lang.String key,
                             java.lang.Boolean defaultValue)

getShort

java.lang.Short getShort(java.lang.String key)

getShort

java.lang.Short getShort(java.lang.String key,
                         java.lang.Short defaultValue)

getBigInteger

java.math.BigInteger getBigInteger(java.lang.String key)

getBigInteger

java.math.BigInteger getBigInteger(java.lang.String key,
                                   java.math.BigInteger defaultValue)

getBigDecimal

java.math.BigDecimal getBigDecimal(java.lang.String key)

getBigDecimal

java.math.BigDecimal getBigDecimal(java.lang.String key,
                                   java.math.BigDecimal defaultValue)

getFloat

java.lang.Float getFloat(java.lang.String key)

getFloat

java.lang.Float getFloat(java.lang.String key,
                         java.lang.Float defaultValue)

getByte

java.lang.Byte getByte(java.lang.String key)

getByte

java.lang.Byte getByte(java.lang.String key,
                       java.lang.Byte defaultValue)

getList

java.util.List<?> getList(java.lang.String key)

Get the property as a list. Depending on the underlying implementation the list may be derived from a comma delimited string or from an actual list structure.

Parameters:

key -

Returns:

getList

<T> java.util.List<T> getList(java.lang.String key,
                              java.lang.Class<T> type)

getList

java.util.List<?> getList(java.lang.String key,
                          java.util.List<?> defaultValue)

get

<T> T get(java.lang.Class<T> type,
          java.lang.String key)

Get the property from the Decoder. All basic data types as well any type will a valueOf or String constructor will be supported.

Parameters:

type -

key -

Returns:

get

<T> T get(java.lang.Class<T> type,
          java.lang.String key,
          T defaultValue)

Get the property from the Decoder. All basic data types as well any type will a valueOf or String constructor will be supported.

Parameters:

type -

key -

Returns:

get

<T> T get(java.lang.reflect.Type type,
          java.lang.String key)

Get the property from the Decoder. Use this method for polymorphic types such as collections.

Use the utility methods in ArchaiusType to get the types for lists, sets and maps.

See Also:

ArchaiusType.forListOf(Class), ArchaiusType.forSetOf(Class), ArchaiusType.forMapOf(Class, Class)

get

<T> T get(java.lang.reflect.Type type,
          java.lang.String key,
          T defaultValue)

Get the property from the Decoder. Use this method for polymorphic types such as collections.

Use the utility methods in ArchaiusType to get the types for lists, sets and maps.

See Also:

ArchaiusType.forListOf(Class), ArchaiusType.forSetOf(Class), ArchaiusType.forMapOf(Class, Class)

containsKey

boolean containsKey(java.lang.String key)

Parameters:

key -

Returns:

True if the key is contained within this or any of its child configurations

getKeys

@Deprecated
java.util.Iterator<java.lang.String> getKeys()

Deprecated. Use keys() instead.

Returns:

An unmodifiable Iterator over all property names owned by this config

keys

default java.lang.Iterable<java.lang.String> keys()

Returns an unmodifiable Iterable of all property names owned by this config.

The default in this interface simply returns a thunk call to getKeys(). Implementations are encouraged to provide their own version. The simplest approach, if the implementation has a Map or similar as its backing store, is to return an equivalent to Collections.unmodifiableSet(map.keySet()).

getKeys

java.util.Iterator<java.lang.String> getKeys(java.lang.String prefix)

Returns:

Return an iterator over all prefixed property names owned by this config

getPrefixedView

Config getPrefixedView(java.lang.String prefix)

Parameters:

prefix -

Returns:

Return a subset of the configuration prefixed by a key. A prefixed view is NOT independent of its parent config. In particular, setting the decoder or the string interpolator is not supported and causes unspecified behavior.

See Also:

getPrivateView()

getPrivateView

Config getPrivateView()

Returns:

A "private view" of this config. The returned object can have its own Decoder, StrInterpolator, and ConfigListeners that will NOT be shared with the original config. Updates to the underlying config's entries WILL be visible and will generate events on any registered listener.

setStrInterpolator

void setStrInterpolator(StrInterpolator interpolator)

Set the interpolator to be used. The interpolator is normally created from the top level configuration object and is passed down to any children as they are added. Setting the interpolator on a child config is not supported and causes unspecified behavior.

Parameters:

interpolator -

See Also:

getPrivateView()

getStrInterpolator

StrInterpolator getStrInterpolator()

setDecoder

void setDecoder(Decoder decoder)

Set the Decoder used by get() to parse any type. The decoder is normally created from the top level configuration object and is passed down to children as they are added. Setting the decoder on a child config is not supported and causes unspecified behavior.

Parameters:

decoder -

See Also:

getPrivateView()

getDecoder

Decoder getDecoder()

accept

<T> T accept(Config.Visitor<T> visitor)

Visitor pattern

Parameters:

visitor -

resolve

default java.lang.String resolve(java.lang.String value)

resolve

default <T> T resolve(java.lang.String value,
                      java.lang.Class<T> type)