Module de.poiu.coat.example

Package de.poiu.coat.example

Class AppConfigBuilder

java.lang.Object

de.poiu.coat.CoatConfigBuilder

de.poiu.coat.example.AppConfigBuilder

@Generated(value="de.poiu.coat.processor.codegeneration.CoatBuilderGenerator",
           date="2024-04-05T21:38:52.453832912+02:00")
public class AppConfigBuilder
extends de.poiu.coat.CoatConfigBuilder

Builder class for creating new AppConfig instances.

Create the builder by calling create(). Then call the add and/or addEnvVars methods for specifying the config sources (and the order in which they are applied), then call build() to create the AppConfig.

Method Summary

Modifier and Type	Method	Description
AppConfigBuilder	add(File file)	Add the config entries from the given file to the built AppConfig.
AppConfigBuilder	add(Map<String,String> map)	Add the config entries from the given Map to the built AppConfig.
AppConfigBuilder	add(Properties jup)	Add the config entries from the given Properties to the built AppConfig.
AppConfigBuilder	addEnvVars()	Add the config entries from the current environment variables to the built AppConfig.
AppConfig	build()	Build a new AppConfig with the config keys from this Builder.
static AppConfigBuilder	create()	Create a builder for AppConfig instances.
static AppConfig	from(File file)	Create a new AppConfig from the given config file.
static AppConfig	from(Map<String,String> props)	Create a new AppConfig from the given config entries.
static AppConfig	from(Properties jup)	Create a new AppConfig from the given config entries.
static AppConfig	fromEnvVars()	Create a new AppConfig from the current environment variables.
static void	writeExampleConfig(Writer writer)	Write an example config file to the given Writer.

Methods inherited from class de.poiu.coat.CoatConfigBuilder

convertPrimitive, convertValue, createMissingKeyFailure, createUnparsableValueFailure, filterByAndStripPrefix, get, get, getArray, getArrayOrDefault, getBoolean, getBooleanOrDefault, getDouble, getDoubleOrDefault, getInt, getIntOrDefault, getList, getListOrDefault, getLong, getLongOrDefault, getOptional, getOptionalDouble, getOptionalDoubleOrDefault, getOptionalInt, getOptionalIntOrDefault, getOptionalLong, getOptionalLongOrDefault, getOptionalOrDefault, getOptionalString, getOrDefault, getParamStrings, getSet, getSetOrDefault, getString, getStringOrDefault, hasPrefix, registerCustomConverter, registerCustomListParser, toMap, toMap, tryConversion, validate

Methods inherited from class java.lang.Object

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

Method Details

from

public static AppConfig from(Map<String,String> props)
                      throws ConfigValidationException

Create a new AppConfig from the given config entries.

Parameters:

props - the config entries

Returns:

the AppConfig created with the given entries

Throws:

ConfigValidationException

from

public static AppConfig from(File file)
                      throws ConfigValidationException,
IOException

Create a new AppConfig from the given config file.

Parameters:

file - the config file to read

Returns:

the AppConfig created with the entries from the given file

Throws:

IOException - if reading the given file failed

ConfigValidationException

from

public static AppConfig from(Properties jup)
                      throws ConfigValidationException

Create a new AppConfig from the given config entries.

Parameters:

jup - the config entries

Returns:

the AppConfig created with the given entries

Throws:

ConfigValidationException

fromEnvVars

public static AppConfig fromEnvVars()
                             throws ConfigValidationException

Create a new AppConfig from the current environment variables.

Since the allowed characters for environment variables are much more restricted than Coat config keys, a relaxed mapping is applied.

Dots and hyphens are treated as underscores. Also uppercase characters in config keys are preceded by an underscore (to convert camelCase to UPPER_CASE). Comparison between the environment variables and the config keys is done case insensitively.

For example the environment variable SERVER_MQTT_HOST will match the config key server.mqttHost.

Returns:

the AppConfig created with the entries in the current environment variables

Throws:

ConfigValidationException

create

public static AppConfigBuilder create()

Create a builder for AppConfig instances.

Call the add and/or addEnvVars methods for specifying the config sources (and the order in which they are applied), then call build() to create the AppConfig

Returns:

a new AppConfigBuilder

add

public AppConfigBuilder add(Map<String,String> map)

Add the config entries from the given Map to the built AppConfig. Already existing config entries with the same keys will be overwritten.

Overrides:

add in class de.poiu.coat.CoatConfigBuilder

Parameters:

map - the config entries to add

Returns:

this Builder

add

public AppConfigBuilder add(File file)
                     throws IOException

Add the config entries from the given file to the built AppConfig. Already existing config entries with the same keys will be overwritten.

Parameters:

file - the file with the config entries to add

Returns:

this Builder

Throws:

IOException - if reading the config file failed

add

public AppConfigBuilder add(Properties jup)

Add the config entries from the given Properties to the built AppConfig. Already existing config entries with the same keys will be overwritten.

Parameters:

jup - the config entries to add

Returns:

this Builder

addEnvVars

public AppConfigBuilder addEnvVars()

Add the config entries from the current environment variables to the built AppConfig. Already existing config entries with the same keys will be overwritten.

Since the allowed characters for environment variables are much more restricted than Coat config keys, a relaxed mapping is applied.

Dots and hyphens are treated as underscores. Also uppercase characters in config keys are preceded by an underscore (to convert camelCase to UPPER_CASE). Comparison between the environment variables and the config keys is done case insensitively.

For example the environment variable SERVER_MQTT_HOST will match the config key server.mqttHost.

Returns:

this Builder

writeExampleConfig

public static void writeExampleConfig(Writer writer)
                               throws IOException

Write an example config file to the given Writer.

Parameters:

writer - the Writer to write to

Throws:

IOException - if writing the example config file fails

build

public AppConfig build()
                throws ConfigValidationException

Build a new AppConfig with the config keys from this Builder.

Returns:

a new AppConfig

Throws:

ConfigValidationException