de.julielab.jssf.commons.spi

Interface ConfigurationTemplateGenerator

All Superinterfaces:

ParameterExposing

public interface ConfigurationTemplateGenerator
extends ParameterExposing

Method Summary

Modifier and Type	Method and Description
default org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode>	createConfigurationTemplate() This default implementation constructs an empty XMLConfiguration with an XPathExpressionEngine and a UTF-8 encoding.
default void	writeConfigurationTemplate(File destination) Generates the configuration template by calling createConfigurationTemplate() and stores the template to destination.

Methods inherited from interface de.julielab.jssf.commons.spi.ParameterExposing

exposeParameters

Method Detail

createConfigurationTemplate

default org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> createConfigurationTemplate()
                                                                                                                                               throws ConfigurationException

This default implementation constructs an empty XMLConfiguration with an XPathExpressionEngine and a UTF-8 encoding. Note that when using this template generation method, the keys of the configuration must be given in XPath form, i.e. 'key/subkey' instead of the default dotted notation 'key.subkey'.

Returns:

An empty XMLConfiguration template.

Throws:

ConfigurationException - If the template generation fails.

writeConfigurationTemplate

default void writeConfigurationTemplate(File destination)
                                 throws ConfigurationException

Generates the configuration template by calling createConfigurationTemplate() and stores the template to destination.

Parameters:

destination - The file path where the template should be written to.

Throws:

ConfigurationException - It template generation of population fails.