dev.dejvokep.boostedyaml.updater.Updater Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 https://dejvokep.dev/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package dev.dejvokep.boostedyaml.updater;

import dev.dejvokep.boostedyaml.block.implementation.Section;
import dev.dejvokep.boostedyaml.settings.general.GeneralSettings;
import dev.dejvokep.boostedyaml.settings.updater.UpdaterSettings;
import dev.dejvokep.boostedyaml.updater.operators.Mapper;
import dev.dejvokep.boostedyaml.updater.operators.Merger;
import dev.dejvokep.boostedyaml.updater.operators.Relocator;
import org.jetbrains.annotations.NotNull;

import java.io.IOException;

/**
 * Updater class responsible for executing the whole process:
 * 
 *     loading version IDs of the document and defaults,
 *     comparing the IDs (to check if updating, downgrading...),
 *     applying relocations and mapping functions to the document (if the files are not the same version ID) - see {@link Relocator} and {@link Mapper},
 *     marking ignored blocks in the document,
 *     merging both files - see {@link Merger#merge(Section, Section, UpdaterSettings)}.
 * 
 */
public class Updater {

    /**
     * Updates the given document against the given defaults and settings. The process consists of:
     * 
     *     loading file version IDs,
     *     comparing the IDs (to check if updating, downgrading...),
     *     applying relocations and mapping functions to the document (if the files are not the same version ID) - see {@link Relocator} and {@link Mapper},
     *     marking ignored blocks in the document,
     *     merging both files - see {@link Merger#merge(Section, Section, UpdaterSettings)}.
     * 
     *
     * @param document        the document section to update
     * @param defaults        section equivalent in the defaults
     * @param updaterSettings updater settings to use
     * @param generalSettings general settings to use
     * @throws IOException an IO error
     */
    public static void update(@NotNull Section document, @NotNull Section defaults, @NotNull UpdaterSettings updaterSettings, @NotNull GeneralSettings generalSettings) throws IOException {
        //Apply versioning stuff
        if (VersionedOperations.run(document, defaults, updaterSettings, generalSettings.getRouteSeparator()))
            return;
        //Merge
        Merger.merge(document, defaults, updaterSettings);
        //If present
        if (updaterSettings.getVersioning() != null)
            //Set the new ID
            updaterSettings.getVersioning().updateVersionID(document, defaults);

        //If auto save is enabled
        if (updaterSettings.isAutoSave())
            document.getRoot().save();
    }

}