net.morimekta.providence.config

Class ProvidenceConfig

java.lang.Object

net.morimekta.providence.config.ProvidenceConfig

public class ProvidenceConfig
extends Object

Providence config loader. This loads providence configs.

Constructor Summary

Constructors

Constructor and Description
ProvidenceConfig(TypeRegistry registry) Make a non-strict config instance.
ProvidenceConfig(TypeRegistry registry, boolean strict) Make a config instance.

Method Summary

Modifier and Type	Method and Description
<M extends PMessage<M,F>,F extends PField> M	getConfig(File file) Load providence config from the given file.
<M extends PMessage<M,F>,F extends PField> M	getConfig(File file, PMessageDescriptor<M,F> descriptor) Load providence config from the given file.
<M extends PMessage<M,F>,F extends PField> Supplier<M>	getSupplier(File file) Load providence config from the given file.
<M extends PMessage<M,F>,F extends PField> Supplier<M>	getSupplier(File file, PMessageDescriptor<M,F> descriptor) Load providence config from the given file.
<M extends PMessage<M,F>,F extends PField> Supplier<M>	getSupplierWithParent(File configFile, File parentFile) Load providence config from the given file, and with a defined parent config.
<M extends PMessage<M,F>,F extends PField> Supplier<M>	getSupplierWithParent(File configFile, File parentFile, PMessageDescriptor<M,F> descriptor) Load providence config from the given file, and with a defined parent config.
<M extends PMessage<M,F>,F extends PField> Supplier<M>	getSupplierWithParent(File file, Supplier<M> parent) Load providence config from the given file, and with a defined parent config.
void	reload(File file) Trigger reloading of the given file, and run recursively up through dependencies.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProvidenceConfig

public ProvidenceConfig(TypeRegistry registry)

Make a non-strict config instance.

Parameters:

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

ProvidenceConfig

public ProvidenceConfig(TypeRegistry registry,
                        boolean strict)

Make a config instance.

Parameters:

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

strict - If the config should be parsed strictly.

Method Detail

getConfig

public <M extends PMessage<M,F>,F extends PField> M getConfig(File file)
                                                       throws IOException

Load providence config from the given file.

Type Parameters:

M - The message type.

F - The message field type.

Parameters:

file - The file to load.

Returns:

The parsed and merged config.

Throws:

IOException - If the file could not be read.

TokenizerException - If the file could not be parsed.

getConfig

public <M extends PMessage<M,F>,F extends PField> M getConfig(File file,
                                                              PMessageDescriptor<M,F> descriptor)
                                                       throws IOException

Load providence config from the given file.

Type Parameters:

M - The message type.

F - The message field type.

Parameters:

file - The file to load.

descriptor - The config type descriptor.

Returns:

The parsed and merged config.

Throws:

IOException - If the file could not be read.

TokenizerException - If the file could not be parsed.

getSupplier

public <M extends PMessage<M,F>,F extends PField> Supplier<M> getSupplier(File file)
                                                                   throws IOException

Load providence config from the given file.

Type Parameters:

M - The message type.

F - The message field type.

Parameters:

file - The file to load.

Returns:

Supplier for the parsed and merged config.

Throws:

IOException - If the file could not be read.

TokenizerException - If the file could not be parsed.

getSupplierWithParent

public <M extends PMessage<M,F>,F extends PField> Supplier<M> getSupplierWithParent(File file,
                                                                                    Supplier<M> parent)
                                                                             throws IOException

Load providence config from the given file, and with a defined parent config. The parent config comes from a supplier, so does not need to be a providence config per se. The loaded config will not be updated when the parent config is updated, as there is no known "upward" dependency. Therefore this should only be used for non-changing config, and for top-level config that does not depend on listening to upstream config changes.

Type Parameters:

M - The message type.

F - The message field type.

Parameters:

file - The file to load.

parent - The parent message for the config to inherit.

Returns:

Supplier for the parsed and merged config.

Throws:

IOException - If the file could not be read.

TokenizerException - If the file could not be parsed.

getSupplierWithParent

public <M extends PMessage<M,F>,F extends PField> Supplier<M> getSupplierWithParent(File configFile,
                                                                                    File parentFile)
                                                                             throws IOException

Load providence config from the given file, and with a defined parent config. The parent config must come from an already loaded config file.

Type Parameters:

M - The message type.

F - The message field type.

Parameters:

configFile - The file to load.

parentFile - The parent config file.

Returns:

Supplier for the parsed and merged config.

Throws:

IOException - If the file could not be read.

TokenizerException - If the file could not be parsed.

getSupplierWithParent

public <M extends PMessage<M,F>,F extends PField> Supplier<M> getSupplierWithParent(File configFile,
                                                                                    File parentFile,
                                                                                    PMessageDescriptor<M,F> descriptor)
                                                                             throws IOException

Load providence config from the given file, and with a defined parent config. The parent config must come from an already loaded config file.

Type Parameters:

M - The message type.

F - The message field type.

Parameters:

configFile - The file to load.

parentFile - The parent config file.

descriptor - The config type descriptor.

Returns:

Supplier for the parsed and merged config.

Throws:

IOException - If the file could not be read.

TokenizerException - If the file could not be parsed.

getSupplier

public <M extends PMessage<M,F>,F extends PField> Supplier<M> getSupplier(File file,
                                                                          PMessageDescriptor<M,F> descriptor)
                                                                   throws IOException

Load providence config from the given file.

Type Parameters:

M - The message type.

F - The message field type.

Parameters:

file - The file to load.

Returns:

Supplier for the parsed and merged config.

Throws:

IOException - If the file could not be read.

TokenizerException - If the file could not be parsed.

reload

public void reload(File file)
            throws IOException

Trigger reloading of the given file, and run recursively up through dependencies.

Parameters:

file - The file that may need to be reloaded.

Throws:

IOException