net.obvj.confectory.merger

Interface ConfigurationMerger<T>

Type Parameters:

T - the source and target Configuration type

All Known Implementing Classes:

AbstractConfigurationMerger, GenericJSONConfigurationMerger, JSONObjectConfigurationMerger, PropertiesConfigurationMerger

public interface ConfigurationMerger<T>

Base abstraction for merging two Configuration objects of the same type <T>.

Since:

2.1.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Method Summary

Modifier and Type

Method and Description

Configuration<T>

merge(Configuration<T> config1, Configuration<T> config2) Combines two Configuration objects into a new Configuration with the following characteristics: The resulting object will receive all the elements of the input Configuration objects In case of conflicting keys, the values at the highest-precedence Configuration will be selected The metadata of the highest-precedence Configuration (namespace and precedence) will be applied to the new Configuration

Method Detail

merge

Configuration<T> merge(Configuration<T> config1,
                       Configuration<T> config2)

Combines two Configuration objects into a new Configuration with the following characteristics:

• The resulting object will receive all the elements of the input Configuration objects
• In case of conflicting keys, the values at the highest-precedence Configuration will be selected
• The metadata of the highest-precedence Configuration (namespace and precedence) will be applied to the new Configuration

Parameters:

config1 - the first Configuration; not null

config2 - the second Configuration; not null

Returns:

a new Configuration resulting from the combination of config1 and config2

Throws:

NullPointerException - if a null Configuration is received