WritableConfigEntry#getValueToWrite can throw a ValidationException

Almighty-Satan · Oct 26, 2023 · f5773a8 · f5773a8
1 parent 4c919d5
commit f5773a8
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/core/src/main/java/io/github/almightysatan/jaskl/impl/WritableConfigEntry.java b/core/src/main/java/io/github/almightysatan/jaskl/impl/WritableConfigEntry.java
@@ -37,17 +37,23 @@ public interface WritableConfigEntry<T> extends ConfigEntry<T> {
      *
      * @param keyPreprocessor a {@link Function} that will be invoked on all map keys
      * @return a value that can be written to a config
-     * @throws InvalidTypeException if the type of this ConfigEntry's value is incorrect. This shouldn't happen under normal circumstances.
+     * @throws InvalidTypeException if the type of this ConfigEntry's value is incorrect. This shouldn't happen under
+     *                              normal circumstances.
+     * @throws ValidationException  if the value fails validation. This could for example happen when using an
+     *                              {@link io.github.almightysatan.jaskl.annotation.AnnotationManager}.
      */
-    @NotNull Object getValueToWrite(@NotNull Function<@NotNull Object, @NotNull Object> keyPreprocessor) throws InvalidTypeException;
+    @NotNull Object getValueToWrite(@NotNull Function<@NotNull Object, @NotNull Object> keyPreprocessor) throws InvalidTypeException, ValidationException;
 
     /**
      * Returns the value that should be written to a persistent config. This also sets modified to false.
      *
      * @return a value that can be written to a config
-     * @throws InvalidTypeException if the type of this ConfigEntry's value is incorrect. This shouldn't happen under normal circumstances.
+     * @throws InvalidTypeException if the type of this ConfigEntry's value is incorrect. This shouldn't happen under
+     *                              normal circumstances.
+     * @throws ValidationException  if the value fails validation. This could for example happen when using an
+     *                              {@link io.github.almightysatan.jaskl.annotation.AnnotationManager}.
      */
-    default @NotNull Object getValueToWrite() throws InvalidTypeException {
+    default @NotNull Object getValueToWrite() throws InvalidTypeException, ValidationException {
         return this.getValueToWrite(Function.identity());
     }