public.javadoc.org.spincast.plugins.config.ConfigFinder.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







ConfigFinder (org.spincast:spincast-framework 1.14.0 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.spincast.plugins.config
Class ConfigFinder



java.lang.Object


org.spincast.plugins.config.ConfigFinder







Direct Known Subclasses:
SpincastConfigDefault




public class ConfigFinder
extends Object











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


static class 
ConfigFinder.ConfigFinderBuilder 









Field Summary

Fields 

Modifier and Type
Field and Description


protected Map<String,Object>
configs 


protected static org.slf4j.Logger
logger 


protected Map<String,Object>
rawConfigs 









Constructor Summary

Constructors 

Modifier
Constructor and Description


protected 
ConfigFinder(String classpathFilePath,
            String externalFilePath,
            List<String> environmentVariablesPrefixes,
            boolean environmentVariablesStripPrefix,
            List<String> systemPropertiesPrefixes,
            boolean systemPropertiesStripPrefix,
            boolean externalFileConfigsOverrideEnvironmentVariables,
            boolean throwExceptionIfSpecifiedClasspathConfigFileIsNotFound,
            boolean throwExceptionIfSpecifiedExternalConfigFileIsNotFound)
This component is not part of the Guice context because
 you can very easily created circular dependencies with
 configurations since they are used everywhere.










Method Summary

All Methods Static Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


protected List<String>
clearPrefixes(List<String> prefixes) 


static ConfigFinder.ConfigFinderBuilder
configure() 


protected Map<String,Object>
expandMap(Map<String,Object> sourceMap)
Parses the keys of the map as "dotted paths" and created
 an expanded Map from them.



protected File
getAppJarDirectory()
If the project is running from an executable
 .jar file, this will return the directory containing
 this .jar file.



protected File
getAppRootDirectoryNoJar()
If the project is not running from an executable
 .jar file, this will return the root directory of the
 project on the file system.



BigDecimal
getBigDecimal(String key) 


BigDecimal
getBigDecimal(String key,
             BigDecimal defaultValue) 


protected BigDecimal
getBigDecimalFromElement(Object val) 


List<BigDecimal>
getBigDecimalList(String key) 


List<BigDecimal>
getBigDecimalList(String key,
                 List<BigDecimal> defaultValue) 


Boolean
getBoolean(String key) 


Boolean
getBoolean(String key,
          Boolean defaultValue) 


protected Boolean
getBooleanFromElement(Object val) 


List<Boolean>
getBooleanList(String key) 


List<Boolean>
getBooleanList(String key,
              List<Boolean> defaultValue) 


protected String
getClasspathFilePath() 


Object
getConfig(String key) 


Object
getConfig(String key,
         Object defaultValue)
Gets an untype config from the config map.



Object
getConfigFromMap(Map<String,Object> map,
                String dottedKey)
Gets a config from the given Map.



Object
getConfigFromMap(Map<String,Object> map,
                String dottedKey,
                Object defaultValue)
Gets a config from the given Map.



List<Object>
getConfigList(String key) 


List<Object>
getConfigList(String key,
             List<?> defaultValue) 


protected Map<String,Object>
getConfigs() 


Date
getDate(String key) 


Date
getDate(String key,
       Date defaultValue) 


protected Date
getDateFromElement(Object date) 


List<Date>
getDateList(String key) 


List<Date>
getDateList(String key,
           List<Date> defaultValue) 


protected Set<Map.Entry<String,String>>
getEnvironmentVariables() 


protected Map<String,Object>
getEnvironmentVariablesConfigs() 


protected List<String>
getEnvironmentVariablesPrefixes() 


protected String
getExternalFilePath() 


Integer
getInteger(String key) 


Integer
getInteger(String key,
          Integer defaultValue) 


protected Integer
getIntegerFromElement(Object val) 


List<Integer>
getIntegerList(String key) 


List<Integer>
getIntegerList(String key,
              List<Integer> defaultValue) 


Long
getLong(String key) 


Long
getLong(String key,
       Long defaultValue) 


protected Long
getLongFromElement(Object val) 


List<Long>
getLongList(String key) 


List<Long>
getLongList(String key,
           List<Long> defaultValue) 


Map<String,Object>
getMap(String key) 


Map<String,Object>
getMap(String key,
      Map<String,Object> defaultValue) 


List<Map<String,Object>>
getMapList(String key) 


List<Map<String,Object>>
getMapList(String key,
          List<Map<String,Object>> defaultValue) 


Object
getRawConfig(String dottedKey)
Gets a config from the raw Map.



protected Map<String,Object>
getRawConfigs()
Get raw configs, as a Map



String
getString(String key) 


String
getString(String key,
         String defaultValue) 


List<String>
getStringList(String key) 


List<String>
getStringList(String key,
             List<String> defaultValue) 


protected Map<String,Object>
getSystemPropertiesConfigs() 


protected List<String>
getSystemPropertiesPrefixes() 


protected boolean
isEnvironmentVariablesStripPrefix() 


protected boolean
isExternalFileConfigsOverrideEnvironmentVariables() 


protected boolean
isSystemPropertiesStripPrefix() 


protected boolean
isThrowExceptionIfSpecifiedClasspathConfigFileIsNotFound() 


protected boolean
isThrowExceptionIfSpecifiedExternalConfigFileIsNotFound() 


protected void
loadYamlFileConfigs(File configFile,
                   org.yaml.snakeyaml.Yaml yaml) 


protected Map<String,Object>
mergeMaps(Map<String,Object> map1,
         Map<String,Object> map2)
Merges two maps :
 
 The elements from the second map override the elements of
 the first map of the same path, except for Map elements which
 are merged.







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














Field Detail





logger
protected static final org.slf4j.Logger logger







rawConfigs
protected Map<String,Object> rawConfigs







configs
protected Map<String,Object> configs









Constructor Detail





ConfigFinder
protected ConfigFinder(String classpathFilePath,
                       String externalFilePath,
                       List<String> environmentVariablesPrefixes,
                       boolean environmentVariablesStripPrefix,
                       List<String> systemPropertiesPrefixes,
                       boolean systemPropertiesStripPrefix,
                       boolean externalFileConfigsOverrideEnvironmentVariables,
                       boolean throwExceptionIfSpecifiedClasspathConfigFileIsNotFound,
                       boolean throwExceptionIfSpecifiedExternalConfigFileIsNotFound)
This component is not part of the Guice context because
 you can very easily created circular dependencies with
 configurations since they are used everywhere.









Method Detail





clearPrefixes
protected List<String> clearPrefixes(List<String> prefixes)







configure
public static ConfigFinder.ConfigFinderBuilder configure()







getClasspathFilePath
protected String getClasspathFilePath()







getExternalFilePath
protected String getExternalFilePath()







getEnvironmentVariablesPrefixes
protected List<String> getEnvironmentVariablesPrefixes()







isEnvironmentVariablesStripPrefix
protected boolean isEnvironmentVariablesStripPrefix()







getSystemPropertiesPrefixes
protected List<String> getSystemPropertiesPrefixes()







isSystemPropertiesStripPrefix
protected boolean isSystemPropertiesStripPrefix()







isExternalFileConfigsOverrideEnvironmentVariables
protected boolean isExternalFileConfigsOverrideEnvironmentVariables()







isThrowExceptionIfSpecifiedClasspathConfigFileIsNotFound
protected boolean isThrowExceptionIfSpecifiedClasspathConfigFileIsNotFound()







isThrowExceptionIfSpecifiedExternalConfigFileIsNotFound
protected boolean isThrowExceptionIfSpecifiedExternalConfigFileIsNotFound()







getConfigs
protected Map<String,Object> getConfigs()







getRawConfigs
protected Map<String,Object> getRawConfigs()
Get raw configs, as a Map







loadYamlFileConfigs
protected void loadYamlFileConfigs(File configFile,
                                   org.yaml.snakeyaml.Yaml yaml)







getEnvironmentVariables
protected Set<Map.Entry<String,String>> getEnvironmentVariables()







getEnvironmentVariablesConfigs
protected Map<String,Object> getEnvironmentVariablesConfigs()







getSystemPropertiesConfigs
protected Map<String,Object> getSystemPropertiesConfigs()







expandMap
protected Map<String,Object> expandMap(Map<String,Object> sourceMap)
Parses the keys of the map as "dotted paths" and created
 an expanded Map from them.







mergeMaps
protected Map<String,Object> mergeMaps(Map<String,Object> map1,
                                       Map<String,Object> map2)
Merges two maps :
 
 The elements from the second map override the elements of
 the first map of the same path, except for Map elements which
 are merged.







getRawConfig
public Object getRawConfig(String dottedKey)
Gets a config from the raw Map. The dotted key
 will be parsed as the path to use.







getConfigFromMap
public Object getConfigFromMap(Map<String,Object> map,
                               String dottedKey)
Gets a config from the given Map. The dotted key
 will be parsed as the path to use.

Returns:
the config value or null if not found.








getConfigFromMap
public Object getConfigFromMap(Map<String,Object> map,
                               String dottedKey,
                               Object defaultValue)
Gets a config from the given Map. The dotted key
 will be parsed as the path to use.

Returns:
the config value or the default value if not found.








getConfig
public Object getConfig(String key)







getConfig
public Object getConfig(String key,
                        Object defaultValue)
Gets an untype config from the config map. If the
 config isn't there, we'll try to get it from
 the raw configs map.
 
 If the resulting config is null, the
 default value will be returned.







getConfigList
public List<Object> getConfigList(String key)







getConfigList
public List<Object> getConfigList(String key,
                                  List<?> defaultValue)







getMap
public Map<String,Object> getMap(String key)







getMap
public Map<String,Object> getMap(String key,
                                 Map<String,Object> defaultValue)







getMapList
public List<Map<String,Object>> getMapList(String key)







getMapList
public List<Map<String,Object>> getMapList(String key,
                                           List<Map<String,Object>> defaultValue)







getString
public String getString(String key)







getString
public String getString(String key,
                        String defaultValue)







getStringList
public List<String> getStringList(String key)







getStringList
public List<String> getStringList(String key,
                                  List<String> defaultValue)







getBooleanFromElement
protected Boolean getBooleanFromElement(Object val)







getBoolean
public Boolean getBoolean(String key)







getBoolean
public Boolean getBoolean(String key,
                          Boolean defaultValue)







getBooleanList
public List<Boolean> getBooleanList(String key)







getBooleanList
public List<Boolean> getBooleanList(String key,
                                    List<Boolean> defaultValue)







getIntegerFromElement
protected Integer getIntegerFromElement(Object val)







getInteger
public Integer getInteger(String key)







getInteger
public Integer getInteger(String key,
                          Integer defaultValue)







getIntegerList
public List<Integer> getIntegerList(String key)







getIntegerList
public List<Integer> getIntegerList(String key,
                                    List<Integer> defaultValue)







getLongFromElement
protected Long getLongFromElement(Object val)







getLong
public Long getLong(String key)







getLong
public Long getLong(String key,
                    Long defaultValue)







getLongList
public List<Long> getLongList(String key)







getLongList
public List<Long> getLongList(String key,
                              List<Long> defaultValue)







getBigDecimalFromElement
protected BigDecimal getBigDecimalFromElement(Object val)







getBigDecimal
public BigDecimal getBigDecimal(String key)







getBigDecimal
public BigDecimal getBigDecimal(String key,
                                BigDecimal defaultValue)







getBigDecimalList
public List<BigDecimal> getBigDecimalList(String key)







getBigDecimalList
public List<BigDecimal> getBigDecimalList(String key,
                                          List<BigDecimal> defaultValue)







getDateFromElement
protected Date getDateFromElement(Object date)







getDate
public Date getDate(String key)







getDate
public Date getDate(String key,
                    Date defaultValue)







getDateList
public List<Date> getDateList(String key)







getDateList
public List<Date> getDateList(String key,
                              List<Date> defaultValue)







getAppJarDirectory
protected File getAppJarDirectory()
If the project is running from an executable
 .jar file, this will return the directory containing
 this .jar file.

Returns:
the directory path or null if the
 application is not running from an executable .jar
 file.








getAppRootDirectoryNoJar
protected File getAppRootDirectoryNoJar()
If the project is not running from an executable
 .jar file, this will return the root directory of the
 project on the file system.

Returns:
the directory path or null if the
 application is running from an executable .jar
 file.














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

Modifier and Type	Field and Description
`protected Map<String,Object>`	`configs`
`protected static org.slf4j.Logger`	`logger`
`protected Map<String,Object>`	`rawConfigs`

Modifier and Type	Method and Description
`protected List<String>`	`clearPrefixes(List<String> prefixes)`
`static ConfigFinder.ConfigFinderBuilder`	`configure()`
`protected Map<String,Object>`	`expandMap(Map<String,Object> sourceMap)` Parses the keys of the map as "dotted paths" and created an expanded Map from them.
`protected File`	`getAppJarDirectory()` If the project is running from an executable .jar file, this will return the directory containing this .jar file.
`protected File`	`getAppRootDirectoryNoJar()` If the project is not running from an executable .jar file, this will return the root directory of the project on the file system.
`BigDecimal`	`getBigDecimal(String key)`
`BigDecimal`	`getBigDecimal(String key, BigDecimal defaultValue)`
`protected BigDecimal`	`getBigDecimalFromElement(Object val)`
`List<BigDecimal>`	`getBigDecimalList(String key)`
`List<BigDecimal>`	`getBigDecimalList(String key, List<BigDecimal> defaultValue)`
`Boolean`	`getBoolean(String key)`
`Boolean`	`getBoolean(String key, Boolean defaultValue)`
`protected Boolean`	`getBooleanFromElement(Object val)`
`List<Boolean>`	`getBooleanList(String key)`
`List<Boolean>`	`getBooleanList(String key, List<Boolean> defaultValue)`
`protected String`	`getClasspathFilePath()`
`Object`	`getConfig(String key)`
`Object`	`getConfig(String key, Object defaultValue)` Gets an untype config from the config map.
`Object`	`getConfigFromMap(Map<String,Object> map, String dottedKey)` Gets a config from the given Map.
`Object`	`getConfigFromMap(Map<String,Object> map, String dottedKey, Object defaultValue)` Gets a config from the given Map.
`List<Object>`	`getConfigList(String key)`
`List<Object>`	`getConfigList(String key, List<?> defaultValue)`
`protected Map<String,Object>`	`getConfigs()`
`Date`	`getDate(String key)`
`Date`	`getDate(String key, Date defaultValue)`
`protected Date`	`getDateFromElement(Object date)`
`List<Date>`	`getDateList(String key)`
`List<Date>`	`getDateList(String key, List<Date> defaultValue)`
`protected Set<Map.Entry<String,String>>`	`getEnvironmentVariables()`
`protected Map<String,Object>`	`getEnvironmentVariablesConfigs()`
`protected List<String>`	`getEnvironmentVariablesPrefixes()`
`protected String`	`getExternalFilePath()`
`Integer`	`getInteger(String key)`
`Integer`	`getInteger(String key, Integer defaultValue)`
`protected Integer`	`getIntegerFromElement(Object val)`
`List<Integer>`	`getIntegerList(String key)`
`List<Integer>`	`getIntegerList(String key, List<Integer> defaultValue)`
`Long`	`getLong(String key)`
`Long`	`getLong(String key, Long defaultValue)`
`protected Long`	`getLongFromElement(Object val)`
`List<Long>`	`getLongList(String key)`
`List<Long>`	`getLongList(String key, List<Long> defaultValue)`
`Map<String,Object>`	`getMap(String key)`
`Map<String,Object>`	`getMap(String key, Map<String,Object> defaultValue)`
`List<Map<String,Object>>`	`getMapList(String key)`
`List<Map<String,Object>>`	`getMapList(String key, List<Map<String,Object>> defaultValue)`
`Object`	`getRawConfig(String dottedKey)` Gets a config from the raw Map.
`protected Map<String,Object>`	`getRawConfigs()` Get raw configs, as a Map
`String`	`getString(String key)`
`String`	`getString(String key, String defaultValue)`
`List<String>`	`getStringList(String key)`
`List<String>`	`getStringList(String key, List<String> defaultValue)`
`protected Map<String,Object>`	`getSystemPropertiesConfigs()`
`protected List<String>`	`getSystemPropertiesPrefixes()`
`protected boolean`	`isEnvironmentVariablesStripPrefix()`
`protected boolean`	`isExternalFileConfigsOverrideEnvironmentVariables()`
`protected boolean`	`isSystemPropertiesStripPrefix()`
`protected boolean`	`isThrowExceptionIfSpecifiedClasspathConfigFileIsNotFound()`
`protected boolean`	`isThrowExceptionIfSpecifiedExternalConfigFileIsNotFound()`
`protected void`	`loadYamlFileConfigs(File configFile, org.yaml.snakeyaml.Yaml yaml)`
`protected Map<String,Object>`	`mergeMaps(Map<String,Object> map1, Map<String,Object> map2)` Merges two maps : The elements from the second map override the elements of the first map of the same path, except for Map elements which are merged.