cn.sissors.hummingbird.runtime.config

Class Configuration

java.lang.Object

cn.sissors.hummingbird.runtime.config.Configuration

Direct Known Subclasses:

JSONConfiguration, PropertiesConfiguration

public abstract class Configuration
extends Object

Configuration class is used to simplify the process of loading multiple configurations into memory.

Version:

2018-10-23

Author:

zyz

Constructor Summary

Constructors

Constructor and Description
Configuration()

Method Summary

Modifier and Type	Method and Description
String	get(String key) Get the setting based on key.
Boolean	getBoolean(String key) Get the setting based on key in boolean.
Boolean	getBooleanOrDefault(String key, boolean defaultValue) Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key in boolean.
Double	getDouble(String key) Get the setting based on key in double.
Double	getDoubleOrDefault(String key, double defaultValue) Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key in double.
Integer	getInt(String key) Get the setting based on key in integer.
Integer	getIntOrDefault(String key, int defaultValue) Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key in integer.
Long	getLong(String key) Get the setting based on key in long.
Long	getLongOrDefault(String key, long defaultValue) Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key in long.
String	getOrDefault(String key, String defaultValue) Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.
Set<String>	keys() Returns a Set view of the keys contained in this map.
abstract Configuration	load() Based on external locations, load configurations into memory.
abstract List<String>	locations() Get locations of all configuration files.
void	set(String key, String value) Set a value to the specified key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Configuration

public Configuration()

Method Detail

get

public String get(String key)

Get the setting based on key.

Parameters:

key - the specified key

Returns:

the setting value

getOrDefault

public String getOrDefault(String key,
                           String defaultValue)

Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the default mapping of the key

Returns:

the setting value

getInt

public Integer getInt(String key)

Get the setting based on key in integer.

Parameters:

key - the specified key

Returns:

the setting value

getIntOrDefault

public Integer getIntOrDefault(String key,
                               int defaultValue)

Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key in integer.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the default mapping of the key

Returns:

the setting value

getDouble

public Double getDouble(String key)

Get the setting based on key in double.

Parameters:

key - the specified key

Returns:

the setting value

getDoubleOrDefault

public Double getDoubleOrDefault(String key,
                                 double defaultValue)

Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key in double.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the default mapping of the key

Returns:

the setting value

getLong

public Long getLong(String key)

Get the setting based on key in long.

Parameters:

key - the specified key

Returns:

the setting value

getLongOrDefault

public Long getLongOrDefault(String key,
                             long defaultValue)

Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key in long.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the default mapping of the key

Returns:

the setting value

getBoolean

public Boolean getBoolean(String key)

Get the setting based on key in boolean.

Parameters:

key - the specified key

Returns:

the setting value

getBooleanOrDefault

public Boolean getBooleanOrDefault(String key,
                                   boolean defaultValue)

Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key in boolean.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the default mapping of the key

Returns:

the setting value

keys

public Set<String> keys()

Returns a Set view of the keys contained in this map.

Returns:

a set view of the keys contained in this map

set

public void set(String key,
                String value)

Set a value to the specified key.

Parameters:

key - the specified key

value - the setting value

load

public abstract Configuration load()

Based on external locations, load configurations into memory.

Returns:

configuration object itself

locations

public abstract List<String> locations()

Get locations of all configuration files.

RECOMMENDED: better to use LinkedList or ImmutableList to ensure the loading order of configuration as there may exist different values with the same key.

Returns:

a list contains all locations