org.kepler.configuration

Class ConfigurationUtilities

java.lang.Object

org.kepler.configuration.ConfigurationUtilities

public class ConfigurationUtilities
extends java.lang.Object

A collection of utilities to manage configuration properties.

Author:

Daniel Crawl

Constructor Summary

Constructors

Constructor and Description
ConfigurationUtilities()

Method Summary

Modifier and Type	Method and Description
static void	copyAllProperties(java.lang.String namespaceStr, java.lang.String destModuleName, java.lang.String srcModuleName) Copy all the properties in a namespace from one module to another.
static void	copyProperties(java.lang.String destModuleName, java.lang.String srcModuleName, java.lang.String destPropertyName, java.lang.String srcPropertyNames) Copy a property or set of properties from one module to another using the default namespace.
static void	copyProperties(java.lang.String namespaceStr, java.lang.String destModuleName, java.lang.String srcModuleName, java.lang.String destPropertyName, java.lang.String srcPropertyNames, boolean setDirty) Copy a property or set of properties from one module to another for a specific namespace.
static void	copyPropertiesToIndices(java.lang.String namespaceStr, java.lang.String destModuleName, java.lang.String srcModuleName, java.lang.String destPropertyName, java.lang.String srcPropertyNames, java.util.ArrayList<java.lang.Integer> indices) Copy a property or set of properties from one module to specific top level indices of another for a specific namespace.
static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getMultiValuePairsMap(ConfigurationProperty property) Get a map of name value pairs in the property where each key can have multiple values.
static java.util.Map<java.lang.String,java.lang.String>	getPairsMap(ConfigurationProperty property) Return a map from a list of name value pairs contained in a property.
static java.util.Map<java.lang.String,java.lang.String>	getPairsMap(ConfigurationProperty property, boolean recurse) Return a map of name value pairs contained in a property.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationUtilities

public ConfigurationUtilities()

Method Detail

getPairsMap

public static java.util.Map<java.lang.String,java.lang.String> getPairsMap(ConfigurationProperty property)

Return a map from a list of name value pairs contained in a property. This returns pairs any any depth of the property.

getPairsMap

public static java.util.Map<java.lang.String,java.lang.String> getPairsMap(ConfigurationProperty property,
                                                                           boolean recurse)

Return a map of name value pairs contained in a property.

Parameters:

property - the property

recurse - if true, look at all depths in the property for pairs. if false, only return pairs from the top level.

getMultiValuePairsMap

public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> getMultiValuePairsMap(ConfigurationProperty property)

Get a map of name value pairs in the property where each key can have multiple values.

copyAllProperties

public static void copyAllProperties(java.lang.String namespaceStr,
                                     java.lang.String destModuleName,
                                     java.lang.String srcModuleName)

Copy all the properties in a namespace from one module to another. NOTE: the changes to the destination are not saved.

copyProperties

public static void copyProperties(java.lang.String destModuleName,
                                  java.lang.String srcModuleName,
                                  java.lang.String destPropertyName,
                                  java.lang.String srcPropertyNames)

Copy a property or set of properties from one module to another using the default namespace. NOTE: the changes to the destination are not saved.

Parameters:

destModuleName - name of destination module

srcModuleName - name of source module

destPropertyName - name of destination property

srcPropertyName - name of property or properties in source module to copy. Can use "a.b.c" format to denote a nested name.

copyProperties

public static void copyProperties(java.lang.String namespaceStr,
                                  java.lang.String destModuleName,
                                  java.lang.String srcModuleName,
                                  java.lang.String destPropertyName,
                                  java.lang.String srcPropertyNames,
                                  boolean setDirty)

Copy a property or set of properties from one module to another for a specific namespace.

Parameters:

namespaceStr - the namespace

destModuleName - name of destination module

srcModuleName - name of source module

destPropertyName - name of destination property

srcPropertyName - name of property or properties in source module to copy. Can use "a.b.c" format to denote a nested name.

setDirty - If true, set the destination property dirty so that it will be saved.

copyPropertiesToIndices

public static void copyPropertiesToIndices(java.lang.String namespaceStr,
                                           java.lang.String destModuleName,
                                           java.lang.String srcModuleName,
                                           java.lang.String destPropertyName,
                                           java.lang.String srcPropertyNames,
                                           java.util.ArrayList<java.lang.Integer> indices)
                                    throws java.lang.Exception

Copy a property or set of properties from one module to specific top level indices of another for a specific namespace.

Parameters:

namespaceStr - the namespace

destModuleName - name of destination module

srcModuleName - name of source module

destPropertyName - name of destination property

srcPropertyName - name of property or properties in source module to copy. Can use "a.b.c" format to denote a nested name.

indices - top level destination indices where properties will be placed

Throws:

java.lang.Exception