se.l4.commons.config

Interface ConfigBuilder

All Known Implementing Classes:

ConfigBuilderImpl

public interface ConfigBuilder

Builder for instances of Config. Makes it easy to create a configuration over several files. When creating a configuration one can opt to use a custom serializer collection and its possible to activate validation via withValidatorFactory(ValidatorFactory).

Author:

Andreas Holstenson

Method Summary

Modifier and Type	Method and Description
ConfigBuilder	addFile(File file) Add a file that should be loaded.
ConfigBuilder	addFile(Path path) Add a file that should be loaded.
ConfigBuilder	addFile(String path) Add a file that should be loaded.
ConfigBuilder	addStream(InputStream stream) Add a stream that should be read.
Config	build() Create the configuration object.
ConfigBuilder	withRoot(File root) Set the root folder of the configuration.
ConfigBuilder	withRoot(Path path) Set the root folder of the configuration.
ConfigBuilder	withRoot(String root) Set the root folder of the configuration.
ConfigBuilder	withSerializerCollection(SerializerCollection serializers) Set the the SerializerCollection to use when reading the configuration files.
ConfigBuilder	withValidatorFactory(javax.validation.ValidatorFactory validation) Set the ValidatorFactory to use when validating loaded configuration objects.

Method Detail

withSerializerCollection

ConfigBuilder withSerializerCollection(SerializerCollection serializers)

Set the the SerializerCollection to use when reading the configuration files.

Parameters:

serializers -

Returns:

withValidatorFactory

ConfigBuilder withValidatorFactory(javax.validation.ValidatorFactory validation)

Set the ValidatorFactory to use when validating loaded configuration objects.

Parameters:

validation -

Returns:

withRoot

ConfigBuilder withRoot(String root)

Set the root folder of the configuration.

Parameters:

root -

Returns:

withRoot

ConfigBuilder withRoot(Path path)

Set the root folder of the configuration.

Parameters:

path -

Returns:

withRoot

ConfigBuilder withRoot(File root)

Set the root folder of the configuration.

Parameters:

root -

Returns:

addFile

ConfigBuilder addFile(String path)

Add a file that should be loaded.

Parameters:

path -

Returns:

addFile

ConfigBuilder addFile(Path path)

Add a file that should be loaded.

Parameters:

path -

Returns:

addFile

ConfigBuilder addFile(File file)

Add a file that should be loaded.

Parameters:

file -

Returns:

addStream

ConfigBuilder addStream(InputStream stream)

Add a stream that should be read.

Parameters:

stream -

Returns:

build

Config build()

Create the configuration object. This will load any declared input files.

Returns: