de.julielab.java.utilities

Class ConfigurationUtilities

java.lang.Object

de.julielab.java.utilities.ConfigurationUtilities

public class ConfigurationUtilities
extends Object

Utilities for the work with commons configuration 2. Note that the dependency for the configuration 2 project is set with scope provided. Thus, the dependency will not automatically be introduced into a project depending on this project. This is done to keep transitive dependencies at a minimum.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LS

Constructor Summary

Constructors

Constructor and Description
ConfigurationUtilities()

Method Summary

Modifier and Type	Method and Description
static void	checkFilesExist(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> importConfig, String... parameters)
static void	checkParameters(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> importConfig, String... parameters)
static String	dot(String... keys) Convenience method for quick concatenation of hierarchical configuration keys.
static String	last(String path)
static org.apache.commons.configuration2.XMLConfiguration	loadXmlConfiguration(File configurationFile) Loads the Apache Commons Configuration2 XMLConfiguration from the given file.
static <T> T	requirePresent(String key, java.util.function.Function<String,T> f)
static String	slash(String... keys) Convenience method for quick concatenation of hierarchical configuration keys into an XPath expression.
static String	ws(String baseElement, String newElement)

Methods inherited from class java.lang.Object

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

Field Detail

LS

public static final String LS

Constructor Detail

ConfigurationUtilities

public ConfigurationUtilities()

Method Detail

requirePresent

public static <T> T requirePresent(String key,
                                   java.util.function.Function<String,T> f)
                            throws org.apache.commons.configuration2.ex.ConfigurationException

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

checkParameters

public static void checkParameters(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> importConfig,
                                   String... parameters)
                            throws org.apache.commons.configuration2.ex.ConfigurationException

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

checkFilesExist

public static void checkFilesExist(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> importConfig,
                                   String... parameters)
                            throws org.apache.commons.configuration2.ex.ConfigurationException

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

loadXmlConfiguration

public static org.apache.commons.configuration2.XMLConfiguration loadXmlConfiguration(File configurationFile)
                                                                               throws org.apache.commons.configuration2.ex.ConfigurationException

Loads the Apache Commons Configuration2 XMLConfiguration from the given file. By default, the XPathExpressionEngine is set.

Parameters:

configurationFile -

Returns:

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

dot

public static String dot(String... keys)

Convenience method for quick concatenation of hierarchical configuration keys. When using Apache Commons Configuration, the DefaultExpressionEngine uses dots as configuration path key separation values by default.

Parameters:

keys - Configuration keys to concatenate into a single hierarchical key.

Returns:

The input keys joined with dots.

slash

public static String slash(String... keys)

Convenience method for quick concatenation of hierarchical configuration keys into an XPath expression.

Parameters:

keys - Configuration keys to concatenate into a single hierarchical key.

Returns:

The input keys joined with slashes for xpath expressions.

ws

public static String ws(String baseElement,
                        String newElement)

last

public static String last(String path)