dev.dejvokep.boostedyaml.updater

Class Updater

java.lang.Object

dev.dejvokep.boostedyaml.updater.Updater

public class Updater
extends Object

Updater class responsible for executing the whole process:

1. loading version IDs of the document and defaults,
2. comparing the IDs (to check if updating, downgrading...),
3. applying relocations to the document (if the files are not the same version ID) - see Relocator.apply(UpdaterSettings, char),
4. marking ignored blocks in the document,
5. merging both files - see Merger.merge(Section, Section, UpdaterSettings).

Constructor Summary

Constructors

Constructor and Description
Updater()

Method Summary

Modifier and Type	Method and Description
static void	update(Section document, Section defaults, UpdaterSettings updaterSettings, GeneralSettings generalSettings) Updates the given document against the given defaults and settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

Updater

public Updater()

Method Detail

update

public static void update(@NotNull
                          Section document,
                          @NotNull
                          Section defaults,
                          @NotNull
                          UpdaterSettings updaterSettings,
                          @NotNull
                          GeneralSettings generalSettings)
                   throws IOException

Updates the given document against the given defaults and settings. The process consists of:

1. loading file version IDs,
2. comparing the IDs (to check if updating, downgrading...),
3. applying relocations to the document (if the files are not the same version ID) - see Relocator.apply(UpdaterSettings, char),
4. marking ignored blocks in the document,
5. merging both files - see Merger.merge(Section, Section, UpdaterSettings).

Parameters:

document - the document section to update

defaults - section equivalent in the defaults

updaterSettings - updater settings to use

generalSettings - general settings to use

Throws:

IOException - an IO error