Added paper module

Author: Biquaternions

.idea/misc.xml

@@ -5,6 +5,7 @@ import kotlin.io.path.Path
 plugins {
     java
     `maven-publish`
+    `java-library`
     id("io.freefair.lombok") version "8.12.1"
     id("com.gradleup.shadow") version "9.0.0-beta8"
 }
@@ -23,14 +24,24 @@ allprojects {
 
 subprojects {
     apply(plugin = "java")
+    apply(plugin = "java-library")
     apply(plugin = "io.freefair.lombok")
     apply(plugin = "maven-publish")
     apply(plugin = "com.gradleup.shadow")
 
-    java {
-        sourceCompatibility = JavaVersion.VERSION_1_8
-        targetCompatibility = JavaVersion.VERSION_1_8
-        withSourcesJar()
+
+    if (project.name == "paper") {
+        java {
+            sourceCompatibility = JavaVersion.VERSION_21
+            targetCompatibility = JavaVersion.VERSION_21
+            withSourcesJar()
+        }
+    } else {
+        java {
+            sourceCompatibility = JavaVersion.VERSION_17
+            targetCompatibility = JavaVersion.VERSION_17
+            withSourcesJar()
+        }
     }
 
     tasks {

build.gradle.kts

@@ -1,4 +1,7 @@
+plugins {
+    `java-library`
+}
 
 dependencies {
-    implementation("dev.dejvokep:boosted-yaml:1.3.7")
+    api("dev.dejvokep:boosted-yaml:1.3.7")
 }

core/build.gradle.kts

@@ -11,6 +11,8 @@
 import net.j4c0b3y.api.config.provider.context.SaveContext;
 import net.j4c0b3y.api.config.utils.ClassUtils;
 import net.j4c0b3y.api.config.utils.Pair;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.io.File;
 import java.io.IOException;
@@ -22,6 +24,7 @@
 import java.lang.reflect.AnnotatedElement;
 import java.lang.reflect.Field;
 import java.lang.reflect.Modifier;
+import java.nio.file.Path;
 import java.util.*;
 
 /**
@@ -83,7 +86,7 @@ public abstract class StaticConfig {
      * @param defaults The optional default resource to be loaded from.
      * @param handler The config handler to use for config settings.
      */
-    public StaticConfig(File file, InputStream defaults, ConfigHandler handler) {
+    public StaticConfig(@NotNull File file, @Nullable InputStream defaults, @NotNull ConfigHandler handler) {
         this.file = file;
         this.handler = handler;
 
@@ -103,10 +106,32 @@ public StaticConfig(File file, InputStream defaults, ConfigHandler handler) {
      * @param handler The config handler to use for config settings.
      */
     @SuppressWarnings("unused")
-    public StaticConfig(File file, ConfigHandler handler) {
+    public StaticConfig(@NotNull File file, @NotNull ConfigHandler handler) {
         this(file, null, handler);
     }
 
+    /**
+     * Creates a new static config, registers it to the config handler.
+     *
+     * @param path The path reference to the file to be used for the configuration document.
+     * @param defaults The optional default resource to be loaded from.
+     * @param handler The config handler to use for config settings.
+     */
+    public StaticConfig(@NotNull Path path, @Nullable InputStream defaults, @NotNull ConfigHandler handler) {
+        this(path.toFile(), defaults, handler);
+    }
+
+    /**
+     * Creates a new static config, registers it to the config handler.
+     *
+     * @param path The path reference to the file to be used for the configuration document.
+     * @param handler The config handler to use for config settings.
+     */
+    @SuppressWarnings("unused")
+    public StaticConfig(@NotNull Path path, @NotNull ConfigHandler handler) {
+        this(path.toFile(), null, handler);
+    }
+
     /**
      * @return The header to be shown at the top of the document file.
      */
@@ -127,6 +152,13 @@ public List<String> getFooter() {
         return Arrays.asList(footer.value());
     }
 
+    public final void initialize() {
+        this.load();
+        this.save();
+    }
+
+    public void afterLoad() {}
+
     /**
      * Creates, relocates and loads the document keys into the static fields.
      */
@@ -136,12 +168,12 @@ public void load() {
             document.reload();
 
             // Perform all registered value relocations.
-            relocate();
+            this.relocate();
 
             // If fields are empty, perform the initialization.
             if (sections.isEmpty()) {
                 sections.put("", new LinkedHashSet<>());
-                initialize(getClass(), "");
+                this.initialize(getClass(), "");
             }
 
             // Load and set each field value from the document.
@@ -167,13 +199,6 @@ public void load() {
                 }
             }
 
-            // Save the field values to the config document.
-            save();
-
-            // If configured, we should format values.
-            if (handler.isFormatValues()) {
-                format();
-            }
         } catch (Exception exception) {
             // Load was unsuccessful, prevent saving.
             success = false;
@@ -182,6 +207,8 @@ public void load() {
 
         // Load was successful, allow saving.
         success = true;
+
+        this.afterLoad();
     }
 
     /**
@@ -209,10 +236,15 @@ public void save() {
             document.wipeComments(document);
 
             // Recurse through the static fields, setting the values in the document.
-            step("");
+            this.step("");
 
             // Set the additional custom comments specified by the user.
-            setComments();
+            this.setComments();
+
+            // If configured, we should format values.
+            if (handler.isFormatValues()) {
+                this.format();
+            }
 
             // Save the document values and comments to file.
             document.save();
@@ -285,8 +317,7 @@ private void step(String path) throws ReflectiveOperationException {
         for (AnnotatedElement member : sections.get(path)) {
             String route = getRoute(member, path);
 
-            if (member instanceof Field) {
-                Field field = (Field) member;
+            if (member instanceof Field field) {
 
                 boolean hidden = field.isAnnotationPresent(Hidden.class);
                 boolean present = document.contains(route);
@@ -329,8 +360,9 @@ private void step(String path) throws ReflectiveOperationException {
 
     /**
      * Formats the values in the config file.
+     * This does not save the document
      */
-    public void format() throws IOException {
+    protected void format() throws IOException {
         try {
             boolean removed = false;
 
@@ -380,8 +412,6 @@ public void format() throws IOException {
                 );
             }
 
-            // Save the formatted values to file.
-            document.save();
         } catch (Exception exception) {
             throw new IOException("Format failed for file '" + file.getName() + "'.", exception);
         }

core/src/main/java/net/j4c0b3y/api/config/StaticConfig.java

@@ -2,6 +2,8 @@
 
 import net.j4c0b3y.api.config.provider.context.LoadContext;
 import net.j4c0b3y.api.config.provider.context.SaveContext;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * Used for (de)serialization between the document and static fields.
@@ -17,13 +19,13 @@ public interface TypeProvider<T> {
      * @param context The load context, containing the object.
      * @return The deserialized type provider generic instance.
      */
-    T load(LoadContext context);
+    @NotNull T load(@NotNull LoadContext context);
 
     /**
      * Serializes the type provider's generic class instance to a yaml object.
      *
      * @param context The generic save context, containing the instance.
      * @return The serialized yaml object.
      */
-    Object save(SaveContext<T> context);
+    @Nullable Object save(@NotNull SaveContext<T> context);
 }

core/src/main/java/net/j4c0b3y/api/config/provider/TypeProvider.java

@@ -3,6 +3,7 @@
 import net.j4c0b3y.api.config.provider.TypeProvider;
 import net.j4c0b3y.api.config.provider.context.LoadContext;
 import net.j4c0b3y.api.config.provider.context.SaveContext;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.Arrays;
 import java.util.List;
@@ -26,7 +27,7 @@ public class BooleanProvider implements TypeProvider<Boolean> {
     private final static List<String> FALSE_VALUES = Arrays.asList("false", "no", "0");
 
     @Override
-    public Boolean load(LoadContext context) {
+    public @NotNull Boolean load(@NotNull LoadContext context) {
         String lowered = String.valueOf(context.getObject()).toLowerCase();
 
         // Return true if the lowered string is a true value.
@@ -48,7 +49,7 @@ public Boolean load(LoadContext context) {
     }
 
     @Override
-    public Object save(SaveContext<Boolean> context) {
+    public @NotNull Object save(@NotNull SaveContext<Boolean> context) {
         return context.getObject();
     }
 }

core/src/main/java/net/j4c0b3y/api/config/provider/impl/BooleanProvider.java

@@ -6,6 +6,7 @@
 import net.j4c0b3y.api.config.provider.context.LoadContext;
 import net.j4c0b3y.api.config.provider.context.SaveContext;
 import net.j4c0b3y.api.config.utils.ClassUtils;
+import org.jetbrains.annotations.NotNull;
 
 import java.lang.reflect.Field;
 import java.util.ArrayList;
@@ -55,7 +56,7 @@ public CollectionProvider(Field field, Supplier<T> supplier, Class<T> ignored, C
     }
 
     @Override
-    public T load(LoadContext context) {
+    public @NotNull T load(@NotNull LoadContext context) {
         // Get the provider associated with the generic.
         TypeProvider<E> provider = handler.provide(generic);
 
@@ -82,7 +83,7 @@ public T load(LoadContext context) {
     }
 
     @Override
-    public Object save(SaveContext<T> context) {
+    public @NotNull Object save(@NotNull SaveContext<T> context) {
         // Get the provider associated with the generic.
         TypeProvider<E> provider = handler.provide(generic);
 

core/src/main/java/net/j4c0b3y/api/config/provider/impl/CollectionProvider.java

@@ -4,6 +4,7 @@
 import net.j4c0b3y.api.config.provider.TypeProvider;
 import net.j4c0b3y.api.config.provider.context.LoadContext;
 import net.j4c0b3y.api.config.provider.context.SaveContext;
+import org.jetbrains.annotations.NotNull;
 
 /**
  * Used for providing enum values.
@@ -20,13 +21,13 @@ public class EnumProvider<T extends Enum<T>> implements TypeProvider<T> {
     private final Class<T> type;
 
     @Override
-    public T load(LoadContext context) {
+    public @NotNull T load(@NotNull LoadContext context) {
         // Load using the context string, transformed to upper case.
         return Enum.valueOf(type, String.valueOf(context.getObject()).toUpperCase());
     }
 
     @Override
-    public Object save(SaveContext<T> context) {
+    public @NotNull Object save(@NotNull SaveContext<T> context) {
         // Save using the enum name.
         return context.getObject().name();
     }

core/src/main/java/net/j4c0b3y/api/config/provider/impl/EnumProvider.java

@@ -6,6 +6,7 @@
 import net.j4c0b3y.api.config.provider.TypeProvider;
 import net.j4c0b3y.api.config.provider.context.LoadContext;
 import net.j4c0b3y.api.config.provider.context.SaveContext;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.LinkedHashMap;
 import java.util.Map;
@@ -31,14 +32,12 @@ public class MapProvider<E, T extends Map<String, E>> implements TypeProvider<T>
 
     @Override
     @SuppressWarnings("unchecked")
-    public T load(LoadContext context) {
+    public @NotNull T load(@NotNull LoadContext context) {
         // Throw if the map is not a section instance.
-        if (!(context.getObject() instanceof Section)) {
+        if (!(context.getObject() instanceof Section section)) {
             throw new IllegalArgumentException("Mapped route must resolve to section.");
         }
 
-        Section section = (Section) context.getObject();
-
         // An ordered map for our deserialized generic entries.
         Map<String, E> entries = new LinkedHashMap<>();
 
@@ -54,7 +53,7 @@ public T load(LoadContext context) {
     }
 
     @Override
-    public Object save(SaveContext<T> saveContext) {
+    public @NotNull Object save(@NotNull SaveContext<T> saveContext) {
         // An ordered map for our serialized yaml object entries.
         Map<String, Object> entries = new LinkedHashMap<>();
         TypeProvider<E> provider = handler.provide(generic);

core/src/main/java/net/j4c0b3y/api/config/provider/impl/MapProvider.java

@@ -4,6 +4,7 @@
 import net.j4c0b3y.api.config.provider.TypeProvider;
 import net.j4c0b3y.api.config.provider.context.LoadContext;
 import net.j4c0b3y.api.config.provider.context.SaveContext;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.ArrayList;
 import java.util.Collection;
@@ -19,7 +20,7 @@
 public class MessageProvider implements TypeProvider<Message> {
 
     @Override
-    public Message load(LoadContext context) {
+    public @NotNull Message load(@NotNull LoadContext context) {
         // If the object is a collection.
         if (context.getObject() instanceof Collection) {
             List<String> parsed = new ArrayList<>();
@@ -39,12 +40,12 @@ public Message load(LoadContext context) {
     }
 
     @Override
-    public Object save(SaveContext<Message> context) {
+    public @NotNull Object save(@NotNull SaveContext<Message> context) {
         Message message = context.getObject();
 
         // If the message is one line, return the first line as a string.
         if (message.getLines().size() == 1) {
-            return message.getLines().get(0);
+            return message.getLines().getFirst();
         }
 
         // If the message is multi-line, return all lines as a list.