Allow overwriting the name prefix

rainbowdashlabs · rainbowdashlabs · commit cc26aaab06f0 · 2026-04-04T00:06:34.000+02:00
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -14,7 +14,7 @@ plugins {
 
 publishData {
     useEldoNexusRepos(false)
-    publishingVersion = "2.0.0"
+    publishingVersion = "2.1.0"
 }
 
 group = "dev.chojo"
diff --git a/docs/configuration_creation.md b/docs/configuration_creation.md
@@ -34,25 +34,24 @@ If you want to use one of those you need to also import the desired data format
 === "json"
 
     ```kts
-    implementation("com.fasterxml.jackson.core", "jackson-databind")
+    implementation("tools.jackson.core", "jackson-databind")
     ```
-
 === "yaml"
 
     !!! warning "Minecraft Users"
         
         Be aware that jacksons yaml format depends on snakeyaml, which is bundled in spigot and paper. You need to use relocation in that case and shade the complete jackson library instead of using the library builder. You might also encounter version conflicts, when the server software relies on another snakeyaml version than your jackson dataformat.
 
     ```kts
-    implementation("com.fasterxml.jackson.core", "jackson-databind")
-    compileOnly("com.fasterxml.jackson.dataformat", "jackson-dataformat-yaml")
+    implementation("tools.jackson.core", "jackson-databind")
+    compileOnly("tools.jackson.dataformat", "jackson-dataformat-yaml")
     ```
 
 === "toml"
 
     ```kts
-    implementation("com.fasterxml.jackson.core", "jackson-databind")
-    compileOnly("com.fasterxml.jackson.dataformat", "jackson-dataformat-toml")
+    implementation("tools.jackson.core", "jackson-databind")
+    compileOnly("tools.jackson.dataformat", "jackson-dataformat-toml")
     ```
 
 ### Retrieving a data format
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -12,6 +12,7 @@ nav:
   - Home: index.md
   - 'Create a Configuration': configuration_creation.md
   - 'Customise a Configuration': customise.md
+  - 'Configuration Overrides': overrides.md
   - 'Examples':
       - 'Jackson Bukkit': examples/jackson_bukkit.md
 theme:
diff --git a/src/main/java/dev/chojo/ocular/Configurations.java b/src/main/java/dev/chojo/ocular/Configurations.java
@@ -6,12 +6,6 @@
 package dev.chojo.ocular;
 
 import com.fasterxml.jackson.annotation.JsonAutoDetect;
-import com.fasterxml.jackson.annotation.PropertyAccessor;
-import tools.jackson.databind.MapperFeature;
-import tools.jackson.databind.ObjectMapper;
-import tools.jackson.databind.cfg.MapperBuilder;
-import tools.jackson.databind.introspect.VisibilityChecker;
-import tools.jackson.databind.type.TypeFactory;
 import dev.chojo.ocular.components.FileWrapper;
 import dev.chojo.ocular.components.Format;
 import dev.chojo.ocular.components.Wrapper;
@@ -29,13 +23,17 @@
 import org.slf4j.Logger;
 import tools.jackson.core.JacksonException;
 import tools.jackson.databind.JacksonModule;
+import tools.jackson.databind.MapperFeature;
+import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.cfg.MapperBuilder;
+import tools.jackson.databind.introspect.VisibilityChecker;
+import tools.jackson.databind.type.TypeFactory;
 
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.time.LocalDateTime;
 import java.time.format.DateTimeFormatter;
-import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
diff --git a/src/main/java/dev/chojo/ocular/ConfigurationsBuilder.java b/src/main/java/dev/chojo/ocular/ConfigurationsBuilder.java
@@ -5,14 +5,14 @@
  */
 package dev.chojo.ocular;
 
-import tools.jackson.databind.ObjectMapper;
-import tools.jackson.databind.cfg.MapperBuilder;
 import dev.chojo.ocular.dataformats.DataFormat;
 import dev.chojo.ocular.impl.ModifyableConfigurations;
 import dev.chojo.ocular.key.Key;
 import dev.chojo.ocular.util.Consumers;
 import org.jetbrains.annotations.NotNull;
 import tools.jackson.databind.JacksonModule;
+import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.cfg.MapperBuilder;
 
 import java.nio.file.Path;
 import java.util.Collection;
@@ -30,6 +30,7 @@
 public class ConfigurationsBuilder<T> {
     private final @NotNull Key<T> main;
     private final List<DataFormat<?, ?>> formats = new LinkedList<>();
+    private final List<JacksonModule> modules = new LinkedList<>();
     private Path base = Path.of(".");
     private ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
     private Configurations<?> parent = null;
@@ -39,7 +40,6 @@ public class ConfigurationsBuilder<T> {
     private Consumer<ObjectMapper> configureWriterMapper = Consumers.identity();
     private Consumer<MapperBuilder<ObjectMapper, ?>> configureBuilder = Consumers.identity();
     private Consumer<ObjectMapper> configureMapper = Consumers.identity();
-    private final List<JacksonModule> modules = new LinkedList<>();
 
 
     /**
diff --git a/src/main/java/dev/chojo/ocular/components/Format.java b/src/main/java/dev/chojo/ocular/components/Format.java
@@ -5,10 +5,10 @@
  */
 package dev.chojo.ocular.components;
 
-import tools.jackson.databind.ObjectMapper;
-import tools.jackson.databind.cfg.MapperBuilder;
 import dev.chojo.ocular.Configurations;
 import dev.chojo.ocular.dataformats.DataFormat;
+import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.cfg.MapperBuilder;
 
 /**
  * The Format class encapsulates the configuration and initialization logic for creating
diff --git a/src/main/java/dev/chojo/ocular/dataformats/DataFormat.java b/src/main/java/dev/chojo/ocular/dataformats/DataFormat.java
@@ -5,11 +5,11 @@
  */
 package dev.chojo.ocular.dataformats;
 
-import tools.jackson.databind.ObjectMapper;
-import tools.jackson.databind.cfg.MapperBuilder;
 import dev.chojo.ocular.exceptions.MissingDataTypeInstallationException;
 import dev.chojo.ocular.key.Key;
 import tools.jackson.databind.JacksonModule;
+import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.cfg.MapperBuilder;
 
 import java.util.Collections;
 import java.util.List;
diff --git a/src/main/java/dev/chojo/ocular/dataformats/TomlDataFormat.java b/src/main/java/dev/chojo/ocular/dataformats/TomlDataFormat.java
@@ -5,8 +5,8 @@
  */
 package dev.chojo.ocular.dataformats;
 
-import tools.jackson.dataformat.toml.TomlMapper;
 import dev.chojo.ocular.exceptions.MissingDataTypeInstallationException;
+import tools.jackson.dataformat.toml.TomlMapper;
 
 public class TomlDataFormat implements DataFormat<TomlMapper, TomlMapper.Builder> {
 
@@ -25,7 +25,7 @@ public void assertInstalled() throws MissingDataTypeInstallationException {
         try {
             Class.forName(TomlMapper.class.getName());
         } catch (ClassNotFoundException e) {
-            throw new MissingDataTypeInstallationException(type(), "com.fasterxml.jackson.dataformat:jackson-dataformat-toml");
+            throw new MissingDataTypeInstallationException(type(), "tools.jackson.dataformat:jackson-dataformat-toml");
         }
     }
 }
diff --git a/src/main/java/dev/chojo/ocular/dataformats/YamlDataFormat.java b/src/main/java/dev/chojo/ocular/dataformats/YamlDataFormat.java
@@ -5,8 +5,8 @@
  */
 package dev.chojo.ocular.dataformats;
 
-import tools.jackson.dataformat.yaml.YAMLMapper;
 import dev.chojo.ocular.exceptions.MissingDataTypeInstallationException;
+import tools.jackson.dataformat.yaml.YAMLMapper;
 import tools.jackson.dataformat.yaml.YAMLWriteFeature;
 
 public class YamlDataFormat implements DataFormat<YAMLMapper, YAMLMapper.Builder> {
@@ -36,7 +36,7 @@ public void assertInstalled() throws MissingDataTypeInstallationException {
         try {
             Class.forName(YAMLMapper.class.getName());
         } catch (ClassNotFoundException e) {
-            throw new MissingDataTypeInstallationException(type(), "com.fasterxml.jackson.dataformat:jackson-dataformat-yaml");
+            throw new MissingDataTypeInstallationException(type(), "tools.jackson.dataformat:jackson-dataformat-yaml");
         }
     }
 }
diff --git a/src/main/java/dev/chojo/ocular/impl/ModifyableConfigurations.java b/src/main/java/dev/chojo/ocular/impl/ModifyableConfigurations.java
@@ -5,13 +5,13 @@
  */
 package dev.chojo.ocular.impl;
 
-import tools.jackson.databind.ObjectMapper;
-import tools.jackson.databind.cfg.MapperBuilder;
 import dev.chojo.ocular.Configurations;
 import dev.chojo.ocular.dataformats.DataFormat;
 import dev.chojo.ocular.key.Key;
 import org.jetbrains.annotations.NotNull;
 import tools.jackson.databind.JacksonModule;
+import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.cfg.MapperBuilder;
 
 import java.nio.file.Path;
 import java.util.LinkedList;
diff --git a/src/main/java/dev/chojo/ocular/locks/KeyLocks.java b/src/main/java/dev/chojo/ocular/locks/KeyLocks.java
@@ -5,8 +5,8 @@
  */
 package dev.chojo.ocular.locks;
 
-import dev.chojo.ocular.key.Key;
 import dev.chojo.ocular.exceptions.ParallelAccessException;
+import dev.chojo.ocular.key.Key;
 
 import java.util.HashSet;
 import java.util.Set;
diff --git a/src/main/java/dev/chojo/ocular/override/EnvVar.java b/src/main/java/dev/chojo/ocular/override/EnvVar.java
@@ -4,6 +4,7 @@
  *     Copyright (C) RainbowDashLabs and Contributor
  */
 package dev.chojo.ocular.override;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
diff --git a/src/main/java/dev/chojo/ocular/override/OverrideApplier.java b/src/main/java/dev/chojo/ocular/override/OverrideApplier.java
@@ -31,7 +31,8 @@
 public final class OverrideApplier {
     private static final Logger log = getLogger(OverrideApplier.class);
 
-    private OverrideApplier() {}
+    private OverrideApplier() {
+    }
 
     /**
      * Applies all available overrides from the given supplier to the configuration object.
diff --git a/src/main/java/dev/chojo/ocular/override/Overwrite.java b/src/main/java/dev/chojo/ocular/override/Overwrite.java
@@ -19,20 +19,24 @@
  * variables and/or system properties.
  * <p>
  * You can specify one or more {@link EnvVar} and/or {@link SysProp} sources. The order you
- * declare them matters: sources listed later take priority over earlier ones. For example:
+ * declare them matters: the first source that provides a value wins. For example:
  * <pre>{@code
  * @Overwrite(sys = @SysProp(), env = @EnvVar())
  * private String host;
  * }</pre>
  * This will first check the system property, then the environment variable. If both are set,
- * the environment variable wins because it is declared last.
+ * the system property wins because it is declared first.
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.FIELD, ElementType.METHOD})
 public @interface Overwrite {
-    /** Environment variable sources to check for an override value. */
+    /**
+     * Environment variable sources to check for an override value.
+     */
     EnvVar[] env() default {};
 
-    /** System property sources to check for an override value. */
+    /**
+     * System property sources to check for an override value.
+     */
     SysProp[] sys() default {};
 }
diff --git a/src/main/java/dev/chojo/ocular/processor/OcularProcessor.java b/src/main/java/dev/chojo/ocular/processor/OcularProcessor.java
diff --git a/src/test/java/dev/chojo/ocular/AnnotationOverrideTest.java b/src/test/java/dev/chojo/ocular/AnnotationOverrideTest.java
diff --git a/src/test/java/dev/chojo/ocular/ConfigurationsTest.java b/src/test/java/dev/chojo/ocular/ConfigurationsTest.java
diff --git a/src/test/java/dev/chojo/ocular/CustomConfigurations.java b/src/test/java/dev/chojo/ocular/CustomConfigurations.java
diff --git a/src/test/java/dev/chojo/ocular/CustomJsonFormat.java b/src/test/java/dev/chojo/ocular/CustomJsonFormat.java
diff --git a/src/test/java/dev/chojo/ocular/JacksonOverrideTest.java b/src/test/java/dev/chojo/ocular/JacksonOverrideTest.java
diff --git a/src/test/java/dev/chojo/ocular/OverrideApplierTest.java b/src/test/java/dev/chojo/ocular/OverrideApplierTest.java

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ plugins {`
`14`	`14`
`15`	`15`	`publishData {`
`16`	`16`	`useEldoNexusRepos(false)`
`17`		`- publishingVersion = "2.0.0"`
	`17`	`+ publishingVersion = "2.1.0"`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`group = "dev.chojo"`
Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,8 @@`
`5`	`5`	`*/`
`6`	`6`	`package dev.chojo.ocular.dataformats;`
`7`	`7`
`8`		`-import tools.jackson.dataformat.toml.TomlMapper;`
`9`	`8`	`import dev.chojo.ocular.exceptions.MissingDataTypeInstallationException;`
	`9`	`+import tools.jackson.dataformat.toml.TomlMapper;`
`10`	`10`
`11`	`11`	`public class TomlDataFormat implements DataFormat<TomlMapper, TomlMapper.Builder> {`
`12`	`12`
`@@ -25,7 +25,7 @@ public void assertInstalled() throws MissingDataTypeInstallationException {`
`25`	`25`	`try {`
`26`	`26`	`Class.forName(TomlMapper.class.getName());`
`27`	`27`	`} catch (ClassNotFoundException e) {`
`28`		`- throw new MissingDataTypeInstallationException(type(), "com.fasterxml.jackson.dataformat:jackson-dataformat-toml");`
	`28`	`+ throw new MissingDataTypeInstallationException(type(), "tools.jackson.dataformat:jackson-dataformat-toml");`
`29`	`29`	`}`
`30`	`30`	`}`
`31`	`31`	`}`