dev.dejvokep.boostedyaml.updater

Class VersionedOperations

java.lang.Object

dev.dejvokep.boostedyaml.updater.VersionedOperations

public class VersionedOperations
extends Object

A utility class which runs version-dependant operations while updating a document.

Constructor Summary

Constructors

Constructor and Description
VersionedOperations()

Method Summary

Modifier and Type	Method and Description
static boolean	run(Section document, Section defaults, UpdaterSettings settings, char separator) Runs version-dependent operations.

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionedOperations

public VersionedOperations()

Method Detail

run

public static boolean run(@NotNull
                          Section document,
                          @NotNull
                          Section defaults,
                          @NotNull
                          UpdaterSettings settings,
                          char separator)

Runs version-dependent operations.

1. If UpdaterSettings.getVersioning() is null, does not proceed and returns false.
2. If the version of the document is not provided (is null), assigns the first version specified by the underlying pattern (see Versioning.getFirstVersion()) and continues.
3. If downgrading and it is disabled, throws an UnsupportedOperationException.
4. If version IDs equal, it is an indications that the document is already up-to-date. Does not proceed and returns true.
5. If upgrading, applies all relocations and mappers within the defined version range.
6. Marks all ignored blocks.
7. Returns true.

Parameters:

document - the document section that's being updated

defaults - section equivalent in the defaults

settings - updater settings to use

separator - the route separator, used to parse string routes

Returns:

if the document is already up-to-date (does not require further manipulation), false otherwise (further manipulation - merging and postprocessing is mandatory)