From 09288895a055cb049d1340db361ca4345c752e1b Mon Sep 17 00:00:00 2001 From: Bernhard Bonigl Date: Tue, 18 Oct 2016 09:58:33 +0200 Subject: [PATCH] Add a config version to config files. Mostly because we need a way to generate missing entries when they got added. --- .../mantle/config/AbstractConfig.java | 1 + .../mantle/config/AbstractConfigFile.java | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/src/main/java/slimeknights/mantle/config/AbstractConfig.java b/src/main/java/slimeknights/mantle/config/AbstractConfig.java index b8330e4..43ecae3 100644 --- a/src/main/java/slimeknights/mantle/config/AbstractConfig.java +++ b/src/main/java/slimeknights/mantle/config/AbstractConfig.java @@ -30,6 +30,7 @@ public abstract class AbstractConfig { val.loader = configFile.loader; val.file = configFile.file; val.insertDefaults(); + val.setConfigVersion(); configFileList.add(val); // note: this is a workaround for generics because the generic info has to match the same class diff --git a/src/main/java/slimeknights/mantle/config/AbstractConfigFile.java b/src/main/java/slimeknights/mantle/config/AbstractConfigFile.java index 53f26e8..2c65870 100644 --- a/src/main/java/slimeknights/mantle/config/AbstractConfigFile.java +++ b/src/main/java/slimeknights/mantle/config/AbstractConfigFile.java @@ -29,6 +29,7 @@ import ninja.leaping.configurate.hocon.HoconConfigurationLoader; import ninja.leaping.configurate.loader.AtomicFiles; import ninja.leaping.configurate.loader.ConfigurationLoader; import ninja.leaping.configurate.objectmapping.ObjectMappingException; +import ninja.leaping.configurate.objectmapping.Setting; import ninja.leaping.configurate.objectmapping.serialize.TypeSerializer; import ninja.leaping.configurate.objectmapping.serialize.TypeSerializers; @@ -42,6 +43,9 @@ public abstract class AbstractConfigFile implements Serializable { // if you want to use it, set it to false in your constructor or something ;o private boolean needsSaving = true; + @Setting("_VERSION") + private int configVersion; + // required constructor for deserialization public AbstractConfigFile() { file = null; @@ -72,6 +76,20 @@ public abstract class AbstractConfigFile implements Serializable { public abstract void insertDefaults(); + /** + * Return a number for the config version. + * If the version number differs from the one in the file the file will be updated. + * So if you add new fields etc. update the number + */ + protected abstract int getConfigVersion(); + + void setConfigVersion() { + if(configVersion != getConfigVersion()) { + configVersion = getConfigVersion(); + setNeedsSaving(); + } + } + public AbstractConfigFile loadFromPacket(byte[] packetData) { ConfigurationLoader packetDataLoader = HoconConfigurationLoader