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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProvidenceConfig.Param

Constructor Summary

Constructors

Constructor and Description
ProvidenceConfig(TypeRegistry registry, Map<String,String> inputParams)
ProvidenceConfig(TypeRegistry registry, Map<String,String> inputParams, List<File> sourceRoots)

Method Summary

Modifier and Type	Method and Description
<M extends PMessage<M,F>,F extends PField> M	load(File file) Load providence config from the given file.
List<ProvidenceConfig.Param>	params(File file) Generate a list of params from the providence config, and it's included subconfigs.
File	resolveFile(File ref, String path) Resolve a file path within the source roots.

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,
                        Map<String,String> inputParams)

ProvidenceConfig

public ProvidenceConfig(TypeRegistry registry,
                        Map<String,String> inputParams,
                        List<File> sourceRoots)

Method Detail

load

public <M extends PMessage<M,F>,F extends PField> M load(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.

SerializerException - If the file could not be parsed.

params

public List<ProvidenceConfig.Param> params(File file)
                                    throws IOException

Generate a list of params from the providence config, and it's included subconfigs.

Parameters:

file - The file to load.

Returns:

The list of params from the loaded configs.

Throws:

IOException - If the file could not be read.

SerializerException - If the file could not be parsed.

resolveFile

public File resolveFile(File ref,
                        String path)
                 throws IOException

Resolve a file path within the source roots.

Parameters:

ref - A file or directory reference

path - The file reference to resolve.

Returns:

The resolved file.

Throws:

FileNotFoundException - When the file is not found.

IOException - When unable to make canonical path.