com.netflix.priam.configSource

Interface IConfigSource

All Known Implementing Classes:

AbstractConfigSource, CompositeConfigSource, MemoryConfigSource, PriamConfigSource, PropertiesConfigSource, SimpleDBConfigSource, SystemPropertiesConfigSource

public interface IConfigSource

Defines the configurations for an application.

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.String key) Check if the given key can be found in the config.
java.lang.String	get(java.lang.String key) Get a String associated with the given configuration key.
boolean	get(java.lang.String key, boolean defaultValue) Get a boolean associated with the given configuration key.
java.lang.Class<?>	get(java.lang.String key, java.lang.Class<?> defaultValue) Get a Class associated with the given configuration key.
double	get(java.lang.String key, double defaultValue) Get a double associated with the given configuration key.
float	get(java.lang.String key, float defaultValue) Get a float associated with the given configuration key.
int	get(java.lang.String key, int defaultValue) Get a int associated with the given configuration key.
long	get(java.lang.String key, long defaultValue) Get a long associated with the given configuration key.
java.lang.String	get(java.lang.String key, java.lang.String defaultValue) Get a String associated with the given configuration key.
<T extends java.lang.Enum<T>> T	get(java.lang.String key, T defaultValue) Get a Enum associated with the given configuration key.
java.util.List<java.lang.String>	getList(java.lang.String key) Get a list of strings associated with the given configuration key.
java.util.List<java.lang.String>	getList(java.lang.String key, java.util.List<java.lang.String> defaultValue) Get a list of strings associated with the given configuration key.
void	initialize(java.lang.String asgName, java.lang.String region) Must be called before any other method.
boolean	isEmpty() Returns true if the size is zero.
void	set(java.lang.String key, java.lang.String value) Set the value for the given key.
int	size() A non-negative integer indicating a count of elements.

Method Detail

initialize

void initialize(java.lang.String asgName,
                java.lang.String region)

Must be called before any other method. This method will allow implementations to do any setup that they require before being called.

Parameters:

asgName: - Name of the asg

region: - Name of the region

size

int size()

A non-negative integer indicating a count of elements.

Returns:

non-negative integer indicating a count of elements.

isEmpty

boolean isEmpty()

Returns true if the size is zero. May be more efficient than calculating size.

Returns:

true if the size is zero otherwise false.

contains

boolean contains(java.lang.String key)

Check if the given key can be found in the config.

Parameters:

key - to look up value.

Returns:

if the key is present

get

java.lang.String get(java.lang.String key)

Get a String associated with the given configuration key.

Parameters:

key - to look up value.

Returns:

value from config or null if not present.

get

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

Get a String associated with the given configuration key.

Parameters:

key - to look up value.

defaultValue - if value is not present.

Returns:

value from config or defaultValue if not present.

get

boolean get(java.lang.String key,
            boolean defaultValue)

Get a boolean associated with the given configuration key.

Parameters:

key - to look up value.

defaultValue - if value is not present.

Returns:

value from config or defaultValue if not present.

get

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

Get a Class associated with the given configuration key.

Parameters:

key - to look up value.

defaultValue - if value is not present.

Returns:

value from config or defaultValue if not present.

get

<T extends java.lang.Enum<T>> T get(java.lang.String key,
                                    T defaultValue)

Get a Enum associated with the given configuration key.

Type Parameters:

T - enum type.

Parameters:

key - to look up value.

defaultValue - if value is not present.

Returns:

value from config or defaultValue if not present.

get

int get(java.lang.String key,
        int defaultValue)

Get a int associated with the given configuration key.

Parameters:

key - to look up value.

defaultValue - if value is not present.

Returns:

value from config or defaultValue if not present.

get

long get(java.lang.String key,
         long defaultValue)

Get a long associated with the given configuration key.

Parameters:

key - to look up value.

defaultValue - if value is not present.

Returns:

value from config or defaultValue if not present.

get

float get(java.lang.String key,
          float defaultValue)

Get a float associated with the given configuration key.

Parameters:

key - to look up value.

defaultValue - if value is not present.

Returns:

value from config or defaultValue if not present.

get

double get(java.lang.String key,
           double defaultValue)

Get a double associated with the given configuration key.

Parameters:

key - to look up value.

defaultValue - if value is not present.

Returns:

value from config or defaultValue if not present.

getList

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

Get a list of strings associated with the given configuration key.

Parameters:

key - to look up value.

Returns:

value from config or an immutable list if not present.

getList

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

Get a list of strings associated with the given configuration key.

Parameters:

key - to look up value.

defaultValue - if value is not present.

Returns:

value from config or defaultValue if not present.

set

void set(java.lang.String key,
         java.lang.String value)

Set the value for the given key.

Parameters:

key - to set value for.

value - to set.