FakeConfiguration (wisdom-test 0.9.1 API)

java.lang.Object
- org.wisdom.test.parents.FakeConfiguration

All Implemented Interfaces:

org.wisdom.api.configuration.Configuration
```
public class FakeConfiguration
extends Object
implements org.wisdom.api.configuration.Configuration
```
A simple, flat, without conversion support implementation of configuration. For testing purpose only.

Field Summary

Fields
Modifier and Type Field and Description

private Map<String,Object> internals

Fields
Modifier and Type	Field and Description
`private Map<String,Object>`	`internals`

Constructor Summary

Constructors
Constructor and Description

FakeConfiguration(Map<String,Object> map)

Constructors
Constructor and Description
`FakeConfiguration(Map<String,Object> map)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`asMap()`
`Properties`	`asProperties()`
`String`	`get(String key)` Get a String property or null if it is not there.
`<T> T`	`get(String key, Class<T> clazz)` Get a custom type property or null if it's not there.
`<T> T`	`get(String key, Class<T> clazz, String defaultValueAsString)` Get a custom type property or the given default value if it's not there.
`<T> T`	`get(String key, Class<T> clazz, T defaultValue)` Get a custom type property or the given default value if it's not there.
`Boolean`	`getBoolean(String key)` Get a property as Boolean or null if not there or if the property is not an integer.
`Boolean`	`getBooleanOrDie(String key)` The "die" method forces this key to be set.
`Boolean`	`getBooleanWithDefault(String key, Boolean defaultValue)` Get a Boolean property or a default value when property cannot be found in any configuration file.
`Long`	`getBytes(String key)` Gets a property for a size in bytes.
`Long`	`getBytes(String key, long defaultValue)` Gets a property for a size in bytes.
`org.wisdom.api.configuration.Configuration`	`getConfiguration(String prefix)` Gets a sub-configuration (instance of `FakeConfiguration`) stored at the key 'prefix'
`Double`	`getDouble(String key)` Get a property as Double or null if not there / or if the property is not an integer.
`Double`	`getDoubleOrDie(String key)` The "die" method forces this key to be set.
`Double`	`getDoubleWithDefault(String key, Double defaultValue)` Get a Double property or a default value when property cannot be found in any configuration file.
`Long`	`getDuration(String key, TimeUnit unit)` Gets a property for a duration.
`Long`	`getDuration(String key, TimeUnit unit, long defaultValue)` Gets a property for a duration.
`Integer`	`getInteger(String key)` Get a property as Integer or null if not there / or if the property is not an integer.
`Integer`	`getIntegerOrDie(String key)` The "die" method forces this key to be set.
`Integer`	`getIntegerWithDefault(String key, Integer defaultValue)` Get a Integer property or a default value when property cannot be found in any configuration file.
`List<String>`	`getList(String key)` Gets the list of values.
`Long`	`getLong(String key)` Get a property as Long or null if not there or if the property is not a long.
`Long`	`getLongOrDie(String key)` The "die" method forces this key to be set.
`Long`	`getLongWithDefault(String key, Long defaultValue)` Get a Long property or a default value when property cannot be found in any configuration file.
`String`	`getOrDie(String key)` The "die" method forces this key to be set.
`<T> T`	`getOrDie(String key, Class<T> clazz)` Get a custom type property.
`String[]`	`getStringArray(String key)` Gets the array of values.
`String`	`getWithDefault(String key, String defaultValue)` Get a String property or a default value when property cannot be found in any configuration file.
`boolean`	`has(String key)` Checks whether the configuration object define a value at the given name / path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - internals
```
private final Map<String,Object> internals
```
- Constructor Detail
  - FakeConfiguration
```
public FakeConfiguration(Map<String,Object> map)
```
- Method Detail
  - getConfiguration
```
public org.wisdom.api.configuration.Configuration getConfiguration(String prefix)
```
    Gets a sub-configuration (instance of FakeConfiguration) stored at the key 'prefix'
    
    Specified by:
    
    getConfiguration in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    prefix - the key
  - has
```
public boolean has(String key)
```
    Checks whether the configuration object define a value at the given name / path. Be aware that this implementation does not check for sub-configuration.
    
    Specified by:
    
    has in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key / path
    
    Returns:
    
    true if the configuration has a non-null value, false otherwise
    
    Since:
    
    0.7
  - get
```
public String get(String key)
```
    Get a String property or null if it is not there.
    
    Specified by:
    
    get in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    Returns:
    
    the property of null if not there
  - get
```
public <T> T get(String key,
                 Class<T> clazz)
```
    Get a custom type property or null if it's not there. No conversion made in this implementation
    
    Specified by:
    
    get in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key the key used in the configuration file.
    
    clazz - the class of the object (must match the stored object)
    
    Returns:
    
    the created object, null if not there
  - getOrDie
```
public <T> T getOrDie(String key,
                      Class<T> clazz)
```
    Get a custom type property. The object is created using the org.wisdom.api.content.ParameterFactories strategy. This "die" method forces this key to be set. Otherwise a runtime exception will be thrown.
    
    Specified by:
    
    getOrDie in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key the key used in the configuration file.
    
    clazz - the class of the object to create
    
    Returns:
    
    the created object. The object cannot be created (because the property is missing, or because the conversion failed) a RuntimeException is thrown.
  - get
```
public <T> T get(String key,
                 Class<T> clazz,
                 T defaultValue)
```
    Get a custom type property or the given default value if it's not there. The object is created using the org.wisdom.api.content.ParameterFactories strategy.
    
    Specified by:
    
    get in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key the key used in the configuration file.
    
    clazz - the class of the object to create
    
    defaultValue - the object returned if the property is missing
    
    Returns:
    
    the created object, or the given default object if not there
  - get
```
public <T> T get(String key,
                 Class<T> clazz,
                 String defaultValueAsString)
```
    Get a custom type property or the given default value if it's not there. The object is created using the org.wisdom.api.content.ParameterFactories strategy.
    
    Specified by:
    
    get in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key the key used in the configuration file.
    
    clazz - the class of the object to create
    
    defaultValueAsString - the 'string' format of the object returned if the property is missing. The object is built using the parameter converters service.
    
    Returns:
    
    the created object, or the given default object if not there
  - getWithDefault
```
public String getWithDefault(String key,
                             String defaultValue)
```
    Get a String property or a default value when property cannot be found in any configuration file.
    
    Specified by:
    
    getWithDefault in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    defaultValue - Default value returned, when value cannot be found in configuration.
    
    Returns:
    
    the value of the key or the default value.
  - getInteger
```
public Integer getInteger(String key)
```
    Get a property as Integer or null if not there / or if the property is not an integer.
    
    Specified by:
    
    getInteger in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    Returns:
    
    the property or null if not there or property no integer
  - getIntegerWithDefault
```
public Integer getIntegerWithDefault(String key,
                                     Integer defaultValue)
```
    Get a Integer property or a default value when property cannot be found in any configuration file.
    
    Specified by:
    
    getIntegerWithDefault in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    defaultValue - Default value returned, when value cannot be found in configuration.
    
    Returns:
    
    the value of the key or the default value.
  - getDouble
```
public Double getDouble(String key)
```
    Get a property as Double or null if not there / or if the property is not an integer.
    
    Specified by:
    
    getDouble in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    Returns:
    
    the property or null if not there or property no integer
    
    Since:
    
    0.7
  - getDoubleWithDefault
```
public Double getDoubleWithDefault(String key,
                                   Double defaultValue)
```
    Get a Double property or a default value when property cannot be found in any configuration file.
    
    Specified by:
    
    getDoubleWithDefault in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    defaultValue - Default value returned, when value cannot be found in configuration.
    
    Returns:
    
    the value of the key or the default value.
    
    Since:
    
    0.7
  - getBoolean
```
public Boolean getBoolean(String key)
```
    Get a property as Boolean or null if not there or if the property is not an integer.
    
    Specified by:
    
    getBoolean in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    Returns:
    
    the property or null if not there or property no boolean
  - getBooleanWithDefault
```
public Boolean getBooleanWithDefault(String key,
                                     Boolean defaultValue)
```
    Get a Boolean property or a default value when property cannot be found in any configuration file.
    
    Specified by:
    
    getBooleanWithDefault in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    defaultValue - Default value returned, when value cannot be found in configuration.
    
    Returns:
    
    the value of the key or the default value.
  - getLong
```
public Long getLong(String key)
```
    Get a property as Long or null if not there or if the property is not a long.
    
    Specified by:
    
    getLong in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    Returns:
    
    the property or null if not there or property no long
  - getLongWithDefault
```
public Long getLongWithDefault(String key,
                               Long defaultValue)
```
    Get a Long property or a default value when property cannot be found in any configuration file.
    
    Specified by:
    
    getLongWithDefault in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    defaultValue - Default value returned, when value cannot be found in configuration.
    
    Returns:
    
    the value of the key or the default value.
  - getLongOrDie
```
public Long getLongOrDie(String key)
```
    The "die" method forces this key to be set. Otherwise a runtime exception will be thrown.
    
    Specified by:
    
    getLongOrDie in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    Returns:
    
    the Long or a RuntimeException will be thrown.
  - getBooleanOrDie
```
public Boolean getBooleanOrDie(String key)
```
    The "die" method forces this key to be set. Otherwise a runtime exception will be thrown.
    
    Specified by:
    
    getBooleanOrDie in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    Returns:
    
    the boolean or a RuntimeException will be thrown.
  - getIntegerOrDie
```
public Integer getIntegerOrDie(String key)
```
    The "die" method forces this key to be set. Otherwise a runtime exception will be thrown.
    
    Specified by:
    
    getIntegerOrDie in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    Returns:
    
    the Integer or a RuntimeException will be thrown.
  - getDoubleOrDie
```
public Double getDoubleOrDie(String key)
```
    The "die" method forces this key to be set. Otherwise a runtime exception will be thrown.
    
    Specified by:
    
    getDoubleOrDie in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    Returns:
    
    the Double or a RuntimeException will be thrown.
    
    Since:
    
    0.7
  - getOrDie
```
public String getOrDie(String key)
```
    The "die" method forces this key to be set. Otherwise a runtime exception will be thrown.
    
    Specified by:
    
    getOrDie in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    Returns:
    
    the String or a RuntimeException will be thrown.
  - getDuration
```
public Long getDuration(String key,
                        TimeUnit unit)
```
    Gets a property for a duration. It retrieves the amount of 'unit' for the duration written in the configuration. For instance, if the configuration contains "2s", and you want to retrieve it as milliseconds (unit), it returns 2000.
    Are supported:
    - ns, nanosecond, nanoseconds
    - us, microsecond, microseconds
    - ms, millisecond, milliseconds
    - s, second, seconds
    - m, minute, minutes
    - h, hour, hours
    - d, day, days
    No conversion in this implementation !
    
    Data must be a long
    Specified by:
    
    getDuration in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    unit - the time unit
    
    Returns:
    
    the duration converted to the given units, null if not found.
    
    Since:
    
    0.7
  - getDuration
```
public Long getDuration(String key,
                        TimeUnit unit,
                        long defaultValue)
```
    Gets a property for a duration. It retrieves the amount of 'unit' for the duration written in the configuration. For instance, if the configuration contains "2s", and you want to retrieve it as milliseconds (unit), it returns 2000.
    Are supported:
    - ns, nanosecond, nanoseconds
    - us, microsecond, microseconds
    - ms, millisecond, milliseconds
    - s, second, seconds
    - m, minute, minutes
    - h, hour, hours
    - d, day, days
    No conversion in this implementation !
    Specified by:
    
    getDuration in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    unit - the time unit
    
    defaultValue - the default value to return if the configuration does not contain the given key
    
    Returns:
    
    the duration converted to the given units, defaultValue if not found.
    
    Since:
    
    0.7
  - getBytes
```
public Long getBytes(String key)
```
    Gets a property for a size in bytes. It retrieves the amount of 'bytes' for the size written in the configuration. This is made to avoid the misleading powers of 1024 with powers of 1000. For instance, if the configuration contains "2kB", it returns 2000. But, if the configuration contains "2K", it returns 2048.
    For single bytes, exactly these strings are supported:
    - B, b, byte, bytes
    For powers of ten, exactly these strings are supported:
    - kB, kilobyte, kilobytes
    - MB, megabyte, megabytes
    - GB, gigabyte, gigabytes
    - TB, terabyte, terabytes
    - PB, petabyte, petabytes
    - EB, exabyte, exabytes
    - ZB, zettabyte, zettabytes
    - YB, yottabyte, yottabytes
    For powers of two, exactly these strings are supported:
    - K, k, Ki, KiB, kibibyte, kibibytes
    - M, m, Mi, MiB, mebibyte, mebibytes
    - G, g, Gi, GiB, gibibyte, gibibytes
    - T, t, Ti, TiB, tebibyte, tebibytes
    - P, p, Pi, PiB, pebibyte, pebibytes
    - E, e, Ei, EiB, exbibyte, exbibytes
    - Z, z, Zi, ZiB, zebibyte, zebibytes
    - Y, y, Yi, YiB, yobibyte, yobibytes
    * No conversion in this implementation !
    Specified by:
    
    getBytes in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    Returns:
    
    the amount of bytes, null if not found.
    
    Since:
    
    0.7
  - getBytes
```
public Long getBytes(String key,
                     long defaultValue)
```
    Gets a property for a size in bytes. It retrieves the amount of 'bytes' for the size written in the configuration. This is made to avoid the misleading powers of 1024 with powers of 1000. For instance, if the configuration contains "2kB", it returns 2000. But, if the configuration contains "2K", it returns 2048.
    For single bytes, exactly these strings are supported:
    - B, b, byte, bytes
    For powers of ten, exactly these strings are supported:
    - kB, kilobyte, kilobytes
    - MB, megabyte, megabytes
    - GB, gigabyte, gigabytes
    - TB, terabyte, terabytes
    - PB, petabyte, petabytes
    - EB, exabyte, exabytes
    - ZB, zettabyte, zettabytes
    - YB, yottabyte, yottabytes
    For powers of two, exactly these strings are supported:
    - K, k, Ki, KiB, kibibyte, kibibytes
    - M, m, Mi, MiB, mebibyte, mebibytes
    - G, g, Gi, GiB, gibibyte, gibibytes
    - T, t, Ti, TiB, tebibyte, tebibytes
    - P, p, Pi, PiB, pebibyte, pebibytes
    - E, e, Ei, EiB, exbibyte, exbibytes
    - Z, z, Zi, ZiB, zebibyte, zebibytes
    - Y, y, Yi, YiB, yobibyte, yobibytes
    Specified by:
    
    getBytes in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key used in the configuration file.
    
    defaultValue - the default value to return if the configuration does not contain the given key
    
    Returns:
    
    the amount of bytes, defaultValue if not found.
    
    Since:
    
    0.7
  - getStringArray
```
public String[] getStringArray(String key)
```
    Gets the array of values. Must have been stored as an array.
    
    Specified by:
    
    getStringArray in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key
    
    Returns:
    
    an array containing the values of that key or empty if not found.
  - getList
```
public List<String> getList(String key)
```
    Gets the list of values. Must have been stored as a list.
    
    Specified by:
    
    getList in interface org.wisdom.api.configuration.Configuration
    
    Parameters:
    
    key - the key
    
    Returns:
    
    an list containing the values of that key or empty if not found.
  - asProperties
```
public Properties asProperties()
```
    Specified by:
    
    asProperties in interface org.wisdom.api.configuration.Configuration
    
    Returns:
    
    All properties that are currently loaded from internal and external files.
  - asMap
```
public Map<String,Object> asMap()
```
    Specified by:
    
    asMap in interface org.wisdom.api.configuration.Configuration
    
    Returns:
    
    All properties that are currently loaded from internal and external files. Modifying the returned map, does not modify the configuration.

Class FakeConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

internals

Constructor Detail

FakeConfiguration

Method Detail

getConfiguration

has

get

get

getOrDie

get

get

getWithDefault

getInteger

getIntegerWithDefault

getDouble

getDoubleWithDefault

getBoolean

getBooleanWithDefault

getLong

getLongWithDefault

getLongOrDie

getBooleanOrDie

getIntegerOrDie

getDoubleOrDie

getOrDie

getDuration

getDuration

getBytes

getBytes

getStringArray

getList

asProperties

asMap