Refactor configuration node on set callbacks to split up load and change events

src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java

@@ -386,7 +386,7 @@ private <N extends Node> N node(N node) {
             .comment("This config option defines the default language Multiverse should use.")
             .defaultValue(Locale.ENGLISH)
             .name("default-locale")
-            .onSetValue((oldValue, newValue) ->
+            .onLoadAndChange((oldValue, newValue) ->
                     commandManager.get().getLocales().setDefaultLocale(newValue))
             .build());
 
@@ -396,9 +396,8 @@ private <N extends Node> N node(N node) {
             .comment("If the player's language does not have a translation, it will use the default language set above instead.")
             .defaultValue(true)
             .name("per-player-locale")
-            .onSetValue((oldValue, newValue) -> {
-                commandManager.get().usePerIssuerLocale(newValue);
-            })
+            .onLoadAndChange((oldValue, newValue) ->
+                    commandManager.get().usePerIssuerLocale(newValue))
             .build());
 
     private final ConfigHeaderNode commandHeader = node(ConfigHeaderNode.builder("command")
@@ -477,7 +476,7 @@ private <N extends Node> N node(N node) {
             .comment("")
             .comment("This config option defines the priority for the PlayerPortalEvent.")
             .name("event-priority-player-portal")
-            .onSetValue((oldValue, newValue) ->
+            .onLoadAndChange((oldValue, newValue) ->
                     eventPriorityMapper.get().setPriority("mvcore-player-portal", newValue))
             .build());
 
@@ -486,15 +485,16 @@ private <N extends Node> N node(N node) {
             .name("event-priority-player-respawn")
             .comment("")
             .comment("This config option defines the priority for the PlayerRespawnEvent.")
-            .onSetValue((oldValue, newValue) ->
+            .onLoadAndChange((oldValue, newValue) ->
                     eventPriorityMapper.get().setPriority("mvcore-player-respawn", newValue))
             .build());
 
     final ConfigNode<EventPriority> eventPriorityPlayerSpawnLocation = node(ConfigNode.builder("event-priority.player-spawn-location", EventPriority.class)
             .defaultValue(EventPriority.NORMAL)
             .comment("")
             .comment("This config option defines the priority for the PlayerSpawnLocationEvent.")
-            .name("event-priority-player-spawn-location").onSetValue((oldValue, newValue) ->
+            .name("event-priority-player-spawn-location")
+            .onLoadAndChange((oldValue, newValue) ->
                     eventPriorityMapper.get().setPriority("mvcore-player-spawn-location", newValue))
             .build());
 
@@ -503,7 +503,7 @@ private <N extends Node> N node(N node) {
             .name("event-priority-player-teleport")
             .comment("")
             .comment("This config option defines the priority for the PlayerTeleportEvent.")
-            .onSetValue((oldValue, newValue) ->
+            .onLoadAndChange((oldValue, newValue) ->
                     eventPriorityMapper.get().setPriority("mvcore-player-teleport", newValue))
             .build());
 
@@ -551,7 +551,7 @@ private <N extends Node> N node(N node) {
             .validator(value -> (value < 0 || value > 3)
                     ? Try.failure(new MultiverseException("Debug level must be between 0 and 3."))
                     : Try.success(null))
-            .onSetValue((oldValue, newValue) -> {
+            .onLoadAndChange((oldValue, newValue) -> {
                 if (newValue != Logging.getDebugLevel()) {
                     Logging.setDebugLevel(newValue);
                     pluginManager.callEvent(new MVDebugModeEvent(newValue));
@@ -565,15 +565,15 @@ private <N extends Node> N node(N node) {
             .comment("This will only work if the above 'global-debug' is set to 1 or more.")
             .defaultValue(false)
             .name("debug-permissions")
-            .onSetValue((oldValue, newValue) -> PermissionUtils.setDebugPermissions(newValue))
+            .onLoadAndChange((oldValue, newValue) -> PermissionUtils.setDebugPermissions(newValue))
             .build());
 
     final ConfigNode<Boolean> silentStart = node(ConfigNode.builder("misc.silent-start", Boolean.class)
             .comment("")
             .comment("If true, the startup console messages will no longer show.")
             .defaultValue(false)
             .name("silent-start")
-            .onSetValue((oldValue, newValue) -> Logging.setShowingConfig(!newValue))
+            .onLoadAndChange((oldValue, newValue) -> Logging.setShowingConfig(!newValue))
             .build());
 
     final ConfigNode<Boolean> showDonationMessage = node(ConfigNode.builder("misc.show-donation-message", Boolean.class)

src/main/java/org/mvplugins/multiverse/core/config/handle/BaseConfigurationHandle.java

@@ -3,19 +3,22 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.logging.Logger;
 
 import com.dumptruckman.minecraft.util.Logging;
 import io.vavr.control.Option;
 import io.vavr.control.Try;
+import org.bukkit.Bukkit;
+import org.bukkit.command.CommandSender;
 import org.bukkit.configuration.ConfigurationSection;
 import org.bukkit.plugin.Plugin;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import org.mvplugins.multiverse.core.config.migration.ConfigMigrator;
 import org.mvplugins.multiverse.core.config.node.ListValueNode;
-import org.mvplugins.multiverse.core.config.node.Node;
 import org.mvplugins.multiverse.core.config.node.NodeGroup;
 import org.mvplugins.multiverse.core.config.node.ValueNode;
 
@@ -84,7 +87,8 @@ protected void setUpNodes() {
         });
 
         nodeValueMap.forEach((valueNode, value) -> {
-            valueNode.onSetValue(value, value);
+            valueNode.onLoad(value);
+            valueNode.onLoadAndChange(Bukkit.getConsoleSender(), null, value);
         });
     }
 
@@ -156,10 +160,29 @@ public <T> T get(@NotNull ValueNode<T> node) {
      * @return Empty try if the value was set, try containing an error otherwise.
      */
     public <T> Try<Void> set(@NotNull ValueNode<T> node, T value) {
+        return set(Bukkit.getConsoleSender(), node, value);
+    }
+
+    /**
+     * Sets the value of a node, if the validator is not null, it will be tested first.
+     *
+     * @param sender The sender who triggered the change.
+     * @param node   The node to set the value of.
+     * @param value  The value to set.
+     * @param <T>    The type of the node value.
+     * @return Empty try if the value was set, try containing an error otherwise.
+     *
+     * @since 5.4
+     */
+    @ApiStatus.AvailableSince("5.4")
+    public <T> Try<Void> set(@NotNull CommandSender sender, @NotNull ValueNode<T> node, T value) {
         return node.validate(value).map(ignore -> {
             T oldValue = get(node);
             nodeValueMap.put(node, value);
-            node.onSetValue(oldValue, get(node));
+            if (!Objects.equals(oldValue, value)) {
+                node.onLoadAndChange(sender, oldValue, value);
+                node.onChange(sender, oldValue, value);
+            }
             return null;
         });
     }

src/main/java/org/mvplugins/multiverse/core/config/handle/StringPropertyHandle.java

@@ -226,7 +226,7 @@ public Try<Void> setPropertyString(@Nullable String name, @Nullable String value
     public Try<Void> setPropertyString(@NotNull CommandSender sender, @Nullable String name, @Nullable String value) {
         return findNode(name, ValueNode.class)
                 .flatMap(node -> node.parseFromString(sender, value)
-                        .flatMap(parsedValue -> handle.set(node, parsedValue)));
+                        .flatMap(parsedValue -> handle.set(sender, node, parsedValue)));
     }
 
     /**

src/main/java/org/mvplugins/multiverse/core/config/node/ConfigNode.java

@@ -14,6 +14,9 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import org.mvplugins.multiverse.core.config.node.functions.NodeChangeCallback;
+import org.mvplugins.multiverse.core.config.node.functions.NodeValueCallback;
+import org.mvplugins.multiverse.core.config.node.functions.SenderNodeChangeCallback;
 import org.mvplugins.multiverse.core.config.node.functions.SenderNodeStringParser;
 import org.mvplugins.multiverse.core.config.node.functions.SenderNodeSuggester;
 import org.mvplugins.multiverse.core.config.node.serializer.DefaultSerializerProvider;
@@ -53,7 +56,9 @@
     protected @Nullable NodeStringParser<T> stringParser;
     protected @Nullable NodeSerializer<T> serializer;
     protected @Nullable Function<T, Try<Void>> validator;
-    protected @Nullable BiConsumer<T, T> onSetValue;
+    protected @Nullable NodeValueCallback<T> onLoad;
+    protected @Nullable NodeChangeCallback<T> onLoadAndChange;
+    protected @Nullable NodeChangeCallback<T> onChange;
 
     protected ConfigNode(
             @NotNull String path,
@@ -66,7 +71,9 @@
             @Nullable NodeStringParser<T> stringParser,
             @Nullable NodeSerializer<T> serializer,
             @Nullable Function<T, Try<Void>> validator,
-            @Nullable BiConsumer<T, T> onSetValue) {
+            @Nullable NodeValueCallback<T> onLoad,
+            @Nullable NodeChangeCallback<T> onLoadAndChange,
+            @Nullable NodeChangeCallback<T> onChange) {
         super(path, comments);
         this.name = name;
         this.type = type;
@@ -82,7 +89,9 @@
                 ? serializer
                 : DefaultSerializerProvider.getDefaultSerializer(type);
         this.validator = validator;
-        this.onSetValue = onSetValue;
+        this.onLoad = onLoad;
+        this.onLoadAndChange = onLoadAndChange;
+        this.onChange = onChange;
     }
 
     /**
@@ -186,9 +195,29 @@
      * {@inheritDoc}
      */
     @Override
-    public void onSetValue(@Nullable T oldValue, @Nullable T newValue) {
-        if (onSetValue != null) {
-            onSetValue.accept(oldValue, newValue);
+    public void onLoad(@Nullable T value) {
+        if (onLoad != null) {
+            onLoad.run(value);
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void onLoadAndChange(@NotNull CommandSender sender, @Nullable T oldValue, @Nullable T newValue) {
+        if (onLoadAndChange != null) {
+            onLoadAndChange.run(sender, oldValue, newValue);
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void onChange(@NotNull CommandSender sender, @Nullable T oldValue, @Nullable T newValue) {
+        if (onChange != null) {
+            onChange.run(sender, oldValue, newValue);
         }
     }
 
@@ -208,7 +237,9 @@
         protected @Nullable NodeStringParser<T> stringParser;
         protected @Nullable NodeSerializer<T> serializer;
         protected @Nullable Function<T, Try<Void>> validator;
-        protected @Nullable BiConsumer<T, T> onSetValue;
+        protected @Nullable NodeValueCallback<T> onLoad;
+        protected @Nullable NodeChangeCallback<T> onLoadAndChange;
+        protected @Nullable NodeChangeCallback<T> onChange;
 
         /**
          * Creates a new builder.
@@ -368,15 +399,83 @@
             return self();
         }
 
+        /**
+         * Sets the action to be performed when the value is loaded.
+         *
+         * @param onLoad    The action to be performed.
+         * @return This builder.
+         */
+        @ApiStatus.AvailableSince("5.4")
+        public @NotNull B onLoad(@NotNull NodeValueCallback<T> onLoad) {
+            this.onLoad = this.onLoad == null ? onLoad : this.onLoad.then(onLoad);
+            return self();
+        }
+
+        /**
+         * Sets the action to be performed when the value is loaded and changed.
+         *
+         * @param onLoadAndChange    The action to be performed.
+         * @return This builder.
+         *
+         * @since 5.4
+         */
+        @ApiStatus.AvailableSince("5.4")
+        public @NotNull B onLoadAndChange(@NotNull NodeChangeCallback<T> onLoadAndChange) {
+            this.onLoadAndChange = this.onLoadAndChange == null ? onLoadAndChange : this.onLoadAndChange.then(onLoadAndChange);
+            return self();
+        }
+
+        /**
+         * Sets the action to be performed when the value is loaded and changed.
+         *
+         * @param onLoadAndChange    The action to be performed.
+         * @return This builder.
+         *
+         * @since 5.4
+         */
+        @ApiStatus.AvailableSince("5.4")
+        public @NotNull B onLoadAndChange(@NotNull SenderNodeChangeCallback<T> onLoadAndChange) {
+            return onLoadAndChange((NodeChangeCallback<T>) onLoadAndChange);
+        }
+
+        /**
+         * Sets the action to be performed when the value is changed.
+         *
+         * @param onChange    The action to be performed.
+         * @return This builder.
+         *
+         * @since 5.4
+         */
+        @ApiStatus.AvailableSince("5.4")
+        public @NotNull B onChange(@NotNull NodeChangeCallback<T> onChange) {
+            this.onChange = this.onChange == null ? onChange : this.onChange.then(onChange);
+            return self();
+        }
+
+        /**
+         * Sets the action to be performed when the value is changed.
+         *
+         * @param onChange    The action to be performed.
+         * @return This builder.
+         *
+         * @since 5.4
+         */
+        @ApiStatus.AvailableSince("5.4")
+        public @NotNull B onChange(@NotNull SenderNodeChangeCallback<T> onChange) {
+            return onChange((NodeChangeCallback<T>) onChange);
+        }
+
         /**
          * Sets the action to be performed when the value is set.
          *
          * @param onSetValue    The action to be performed.
          * @return This builder.
+         *
+         * @deprecated Use {@link #onLoadAndChange(NodeChangeCallback)} instead.
          */
+        @Deprecated(since = "5.4", forRemoval = true)
         public @NotNull B onSetValue(@NotNull BiConsumer<T, T> onSetValue) {
-            this.onSetValue = this.onSetValue == null ? onSetValue : this.onSetValue.andThen(onSetValue);
-            return self();
+            return onLoadAndChange(onSetValue::accept);
         }
 
         /**
@@ -385,7 +484,8 @@
         @Override
         public @NotNull ConfigNode<T> build() {
             return new ConfigNode<>(path, comments.toArray(new String[0]),
-                    name, type, aliases, defaultValue, suggester, stringParser, serializer, validator, onSetValue);
+                    name, type, aliases, defaultValue, suggester, stringParser, serializer, validator,
+                    onLoad, onLoadAndChange, onChange);
         }
     }
 }