com.github.susom.database

Interface ConfigFrom

All Superinterfaces:

Supplier<Config>

All Known Implementing Classes:

ConfigFromImpl

public interface ConfigFrom
extends Supplier<Config>

Pull configuration properties from various sources and filter/manipulate them.

Author:

garricko

Method Summary

Modifier and Type	Method and Description
ConfigFrom	addPrefix(String prefix)
ConfigFrom	config(Config config)
ConfigFrom	config(Supplier<Config> config)
ConfigFrom	custom(Function<String,String> keyValueLookup)
ConfigFrom	defaultPropertyFiles() Adds a set of properties files to read from, which can be overridden by a system property "properties".
ConfigFrom	defaultPropertyFiles(String systemPropertyKey, CharsetDecoder decoder, String... filenames) Adds a set of properties files to read from, which can be overridden by a specified system property.
ConfigFrom	defaultPropertyFiles(String systemPropertyKey, String... filenames) Adds a set of properties files to read from, which can be overridden by a specified system property.
ConfigFrom	env()
ConfigFrom	excludeKeys(String... keys)
ConfigFrom	excludePrefix(String... prefixes)
ConfigFrom	excludeRegex(String regex)
static ConfigFrom	firstOf() Convenience method for fluent syntax.
Config	get()
ConfigFrom	includeKeys(String... keys)
ConfigFrom	includePrefix(String... prefixes)
ConfigFrom	includeRegex(String regex)
static Config	other(Function<String,String> other)
ConfigFrom	properties(Properties properties)
ConfigFrom	propertyFile(CharsetDecoder decoder, File... files)
ConfigFrom	propertyFile(CharsetDecoder decoder, String... filenames)
ConfigFrom	propertyFile(File... files)
ConfigFrom	propertyFile(String... filenames)
ConfigFrom	removePrefix(String... prefixes)
ConfigFrom	rename(String key, String newKey)
ConfigFrom	substitutions(Config config)
ConfigFrom	systemProperties()
ConfigFrom	value(String key, String value)

Method Detail

firstOf

@Nonnull
static ConfigFrom firstOf()

Convenience method for fluent syntax.

Returns:

a builder for specifying from where configuration should be loaded

other

@Nonnull
static Config other(Function<String,String> other)

custom

ConfigFrom custom(Function<String,String> keyValueLookup)

value

ConfigFrom value(String key,
                 String value)

systemProperties

ConfigFrom systemProperties()

env

ConfigFrom env()

properties

ConfigFrom properties(Properties properties)

config

ConfigFrom config(Config config)

config

ConfigFrom config(Supplier<Config> config)

defaultPropertyFiles

ConfigFrom defaultPropertyFiles()

Adds a set of properties files to read from, which can be overridden by a system property "properties". Equivalent to:

   defaultPropertyFiles("properties", "conf/app.properties", "local.properties", "sample.properties")
 

defaultPropertyFiles

ConfigFrom defaultPropertyFiles(String systemPropertyKey,
                                String... filenames)

Adds a set of properties files to read from, which can be overridden by a specified system property. Equivalent to:

   defaultPropertyFiles(systemPropertyKey, Charset.defaultCharset().newDecoder(), filenames)
 

defaultPropertyFiles

ConfigFrom defaultPropertyFiles(String systemPropertyKey,
                                CharsetDecoder decoder,
                                String... filenames)

Adds a set of properties files to read from, which can be overridden by a specified system property. Equivalent to:

   propertyFile(Charset.defaultCharset().newDecoder(),
       System.getProperty(systemPropertyKey, String.join(File.pathSeparator, filenames))
       .split(File.pathSeparator));
 

propertyFile

ConfigFrom propertyFile(String... filenames)

propertyFile

ConfigFrom propertyFile(CharsetDecoder decoder,
                        String... filenames)

propertyFile

ConfigFrom propertyFile(File... files)

propertyFile

ConfigFrom propertyFile(CharsetDecoder decoder,
                        File... files)

rename

ConfigFrom rename(String key,
                  String newKey)

includeKeys

ConfigFrom includeKeys(String... keys)

includePrefix

ConfigFrom includePrefix(String... prefixes)

includeRegex

ConfigFrom includeRegex(String regex)

excludeKeys

ConfigFrom excludeKeys(String... keys)

excludePrefix

ConfigFrom excludePrefix(String... prefixes)

excludeRegex

ConfigFrom excludeRegex(String regex)

removePrefix

ConfigFrom removePrefix(String... prefixes)

addPrefix

ConfigFrom addPrefix(String prefix)

substitutions

ConfigFrom substitutions(Config config)

get

Config get()

Specified by:

get in interface Supplier<Config>