net.morimekta.providence.config

Class ConfigLoader

java.lang.Object

net.morimekta.providence.config.ConfigLoader

All Implemented Interfaces:

AutoCloseable

public class ConfigLoader
extends Object
implements AutoCloseable

Providence config loader. This loads providence configs.

Constructor Summary

Constructors

Constructor and Description
ConfigLoader(net.morimekta.providence.types.TypeRegistry registry) Make a non-strict config instance.
ConfigLoader(net.morimekta.providence.types.TypeRegistry registry, Consumer<ConfigWarning> warningHandler) Make a non-strict config instance.
ConfigLoader(net.morimekta.providence.types.TypeRegistry registry, net.morimekta.util.FileWatcher watcher, Consumer<ConfigWarning> warningHandler, boolean strict) Make a config instance.
ConfigLoader(net.morimekta.providence.types.TypeRegistry registry, net.morimekta.util.FileWatcher watcher, Consumer<ConfigWarning> warningHandler, boolean strict, Clock clock) Make a config instance.

Method Summary

Modifier and Type	Method and Description
void	close()
<M extends net.morimekta.providence.PMessage<M>> M	getConfig(Path configFile) Get config for the given file.
<M extends net.morimekta.providence.PMessage<M>> M	getConfig(Path configFile, M parent) Get config for the given with parent.
<M extends net.morimekta.providence.PMessage<M>> ConfigSupplier<M>	loadFile(Path configFile) Load a config file without parent config like on config file includes.
<M extends net.morimekta.providence.PMessage<M>> ConfigSupplier<M>	loadFile(Path configFile, ConfigSupplier<M> parentConfig) Load a config file overlaying another config.
<M extends net.morimekta.providence.PMessage<M>> ConfigSupplier<M>	loadResource(String resourcePath) Load a config resource without parent config like on config file includes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigLoader

public ConfigLoader(@Nonnull
                    net.morimekta.providence.types.TypeRegistry registry)

Make a non-strict config instance.

Parameters:

registry - The type registry used to find message and enum types.

ConfigLoader

public ConfigLoader(@Nonnull
                    net.morimekta.providence.types.TypeRegistry registry,
                    @Nonnull
                    Consumer<ConfigWarning> warningHandler)

Make a non-strict config instance.

Parameters:

registry - The type registry used to find message and enum types.

warningHandler - Handle parse warnings.

ConfigLoader

public ConfigLoader(@Nonnull
                    net.morimekta.providence.types.TypeRegistry registry,
                    @Nonnull
                    net.morimekta.util.FileWatcher watcher,
                    @Nonnull
                    Consumer<ConfigWarning> warningHandler,
                    boolean strict)

Make a config instance.

Parameters:

registry - The type registry used to find message and enum types.

watcher - File watcher used to detect config file updates.

warningHandler - Handle parse warnings.

strict - If the config should be parsed and verified strictly.

ConfigLoader

public ConfigLoader(@Nonnull
                    net.morimekta.providence.types.TypeRegistry registry,
                    @Nonnull
                    net.morimekta.util.FileWatcher watcher,
                    @Nonnull
                    Consumer<ConfigWarning> warningHandler,
                    boolean strict,
                    @Nonnull
                    Clock clock)

Make a config instance.

Parameters:

registry - The type registry used to find message and enum types.

watcher - File watcher used to detect config file updates.

warningHandler - Handle parse warnings.

strict - If the config should be parsed strictly.

clock - The clock to use in timing config loads.

Method Detail

loadFile

@Nonnull
public <M extends net.morimekta.providence.PMessage<M>> ConfigSupplier<M> loadFile(@Nonnull
                                                                                            Path configFile,
                                                                                            @Nonnull
                                                                                            ConfigSupplier<M> parentConfig)
                                                                                     throws ConfigException

Load a config file overlaying another config.

Type Parameters:

M - The message type.

Parameters:

configFile - The file to resolve.

parentConfig - The parent config supplier if any.

Returns:

The resolved config.

Throws:

ConfigException - If parsing of config failed.

loadFile

@Nonnull
public <M extends net.morimekta.providence.PMessage<M>> ConfigSupplier<M> loadFile(@Nonnull
                                                                                            Path configFile)
                                                                                     throws ConfigException

Load a config file without parent config like on config file includes.

Type Parameters:

M - The message type.

Parameters:

configFile - The file to resolve.

Returns:

The resolved config.

Throws:

ConfigException - If parsing of config failed.

loadResource

public <M extends net.morimekta.providence.PMessage<M>> ConfigSupplier<M> loadResource(@Nonnull
                                                                                       String resourcePath)
                                                                                throws ConfigException

Load a config resource without parent config like on config file includes.

Type Parameters:

M - The message type.

Parameters:

resourcePath - The file to resolve.

Returns:

The resolved config.

Throws:

ConfigException - If parsing of config failed.

getConfig

@Nonnull
public <M extends net.morimekta.providence.PMessage<M>> M getConfig(@Nonnull
                                                                             Path configFile)
                                                                      throws ConfigException

Get config for the given file.

Type Parameters:

M - The config message type.

Parameters:

configFile - The file to read config for.

Returns:

The config message.

Throws:

ConfigException - On config load failure.

getConfig

@Nonnull
public <M extends net.morimekta.providence.PMessage<M>> M getConfig(@Nonnull
                                                                             Path configFile,
                                                                             @Nonnull
                                                                             M parent)
                                                                      throws ConfigException

Get config for the given with parent.

Type Parameters:

M - The config message type.

Parameters:

configFile - The file to read config for.

parent - The designated parent config.

Returns:

The config message.

Throws:

ConfigException - On config load failure.

close

public void close()

Specified by:

close in interface AutoCloseable