com.netflix.archaius.api

Interface Config

All Known Subinterfaces:

CompositeConfig, SettableConfig

public interface Config

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>

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)
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()
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)
java.lang.Object	getRawProperty(java.lang.String key) Return the raw, uninterpolated, object associated with a key.
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()
boolean	isEmpty()
void	removeListener(ConfigListener listener) Remove a previously registered listener.
void	setDecoder(Decoder decoder) Set the Decoder used by get() to parse any type
void	setStrInterpolator(StrInterpolator interpolator) Set the interpolator to be used.

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, uninterpolated, object associated with a key.

Parameters:

key -

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 contructor will be supported.

Parameters:

type -

key -

Returns:

get

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

containsKey

boolean containsKey(java.lang.String key)

Parameters:

key -

Returns:

True if the key is contained within this or any of it's child configurations

isEmpty

boolean isEmpty()

Returns:

True if empty or false otherwise.

getKeys

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

Returns:

Return an iterator to all property names owned by this config

getKeys

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

Returns:

Return an interator to 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.

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.

Parameters:

interpolator -

getStrInterpolator

StrInterpolator getStrInterpolator()

setDecoder

void setDecoder(Decoder decoder)

Set the Decoder used by get() to parse any type

Parameters:

decoder -

getDecoder

Decoder getDecoder()

accept

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

Visitor pattern

Parameters:

visitor -