57 lines
2.3 KiB
Java
57 lines
2.3 KiB
Java
/*
|
|
* This file is a part of the SteamWar software.
|
|
*
|
|
* Copyright (C) 2025 SteamWar.de-Serverteam
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
package de.steamwar.bausystem.configplayer;
|
|
|
|
import yapion.hierarchy.types.YAPIONObject;
|
|
|
|
/**
|
|
* A new {@link ConfigConverter} should be written when you remove anything
|
|
* from the Config or modify any mayor part. When you move anything from
|
|
* any key to any other key you should write a new {@link ConfigConverter}.
|
|
* For adding any new key you should be able to get the default without
|
|
* having it in the Config. Anything you need to change you should also
|
|
* change the {@link ConfigCreator} accordingly, to produce the new Config.
|
|
*/
|
|
public interface ConfigConverter {
|
|
|
|
/**
|
|
* This describes the version this Converter can convert from. The version
|
|
* it should convert to is the version 1 above this number. But this is not
|
|
* a necessity. In the config Object as parameter given in {@link #update(YAPIONObject)}
|
|
* you should update the <b>@version</b> variable in the root object to the
|
|
* new version this converter produced.
|
|
*
|
|
* @return the version number
|
|
*/
|
|
int version();
|
|
|
|
/**
|
|
* This method should update everything needed to go from a lower config
|
|
* version to a higher. It should update the <b>@version</b> variable
|
|
* accordingly. Anything else is up the implementation. If anything goes wrong
|
|
* do not silently exit this method, throw an Exception. The updater Code will
|
|
* deal with it. Never leave the inputted object in a corrupted state.
|
|
*
|
|
* @param config the config object to update
|
|
*/
|
|
void update(YAPIONObject config);
|
|
|
|
}
|