dev.dejvokep.boostedyaml.updater

Class Merger

java.lang.Object

dev.dejvokep.boostedyaml.updater.Merger

public class Merger
extends Object

Class responsible for merging the document with the defaults. Merging is the final stage of the updating process.

Constructor Summary

Constructors

Constructor and Description
Merger()

Method Summary

Modifier and Type	Method and Description
static void	merge(Section document, Section defaults, UpdaterSettings settings) Merges the given document with the defaults.

Methods inherited from class java.lang.Object

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

Constructor Detail

Merger

public Merger()

Method Detail

merge

public static void merge(@NotNull
                         Section document,
                         @NotNull
                         Section defaults,
                         @NotNull
                         UpdaterSettings settings)

Merges the given document with the defaults.

Merging algorithm consists of iterating through blocks in the defaults and for each pair (document+default block) outputs the preserved one (according to the merging rules) into the document. If the block is ignored, immediately continues without changing the block. If the preserved block is the default one, deep copies it (so it is isolated from the defaults). If both blocks represent sections, iterates through these pair of subsections.

Additionally, after iteration had finished, deletes all non-merged blocks (those which are not contained in the defaults) from the document, unless UpdaterSettings.isKeepAll() is enabled.

Parameters:

document - the document

defaults - the default equivalent to the document

settings - updater settings to use

See Also:

iterate(Section, Section, UpdaterSettings)