aboutsummaryrefslogtreecommitdiff
path: root/common/src/main/java/dev/isxander/yacl/config/GsonConfigInstance.java
diff options
context:
space:
mode:
authorisXander <xandersmith2008@gmail.com>2023-06-03 23:10:03 +0100
committerisXander <xandersmith2008@gmail.com>2023-06-04 16:25:09 +0100
commit3e36feeef60e56ef8cb7f737ac8eeab9fbcd6abb (patch)
treef9c3395b4da2235681b87a35ac5056a0724a181b /common/src/main/java/dev/isxander/yacl/config/GsonConfigInstance.java
parentd00a486d3bdf6105f8ca8af1034c384058b8c832 (diff)
downloadYetAnotherConfigLib-3e36feeef60e56ef8cb7f737ac8eeab9fbcd6abb.tar.gz
YetAnotherConfigLib-3e36feeef60e56ef8cb7f737ac8eeab9fbcd6abb.tar.bz2
YetAnotherConfigLib-3e36feeef60e56ef8cb7f737ac8eeab9fbcd6abb.zip
Change package and modid to yacl3 and yet_another_config_lib_3 respectively
Diffstat (limited to 'common/src/main/java/dev/isxander/yacl/config/GsonConfigInstance.java')
-rw-r--r--common/src/main/java/dev/isxander/yacl/config/GsonConfigInstance.java212
1 files changed, 0 insertions, 212 deletions
diff --git a/common/src/main/java/dev/isxander/yacl/config/GsonConfigInstance.java b/common/src/main/java/dev/isxander/yacl/config/GsonConfigInstance.java
deleted file mode 100644
index ad7f550..0000000
--- a/common/src/main/java/dev/isxander/yacl/config/GsonConfigInstance.java
+++ /dev/null
@@ -1,212 +0,0 @@
-package dev.isxander.yacl.config;
-
-import com.google.gson.*;
-import dev.isxander.yacl.impl.utils.YACLConstants;
-import net.minecraft.network.chat.Component;
-import net.minecraft.network.chat.Style;
-
-import java.awt.*;
-import java.io.IOException;
-import java.lang.reflect.Type;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.nio.file.StandardOpenOption;
-import java.util.function.UnaryOperator;
-
-/**
- * Uses GSON to serialize and deserialize config data from JSON to a file.
- *
- * Only fields annotated with {@link ConfigEntry} are included in the JSON.
- * {@link Component}, {@link Style} and {@link Color} have default type adapters, so there is no need to provide them in your GSON instance.
- * GSON is automatically configured to format fields as {@code lower_camel_case}.
- *
- * @param <T> config data type
- */
-public class GsonConfigInstance<T> extends ConfigInstance<T> {
- private final Gson gson;
- private final Path path;
-
- @Deprecated
- public GsonConfigInstance(Class<T> configClass, Path path) {
- this(configClass, path, new GsonBuilder());
- }
-
- @Deprecated
- public GsonConfigInstance(Class<T> configClass, Path path, Gson gson) {
- this(configClass, path, gson.newBuilder());
- }
-
- @Deprecated
- public GsonConfigInstance(Class<T> configClass, Path path, UnaryOperator<GsonBuilder> builder) {
- this(configClass, path, builder.apply(new GsonBuilder()));
- }
-
- @Deprecated
- public GsonConfigInstance(Class<T> configClass, Path path, GsonBuilder builder) {
- super(configClass);
- this.path = path;
- this.gson = builder
- .setExclusionStrategies(new ConfigExclusionStrategy())
- .registerTypeHierarchyAdapter(Component.class, new Component.Serializer())
- .registerTypeHierarchyAdapter(Style.class, new Style.Serializer())
- .registerTypeHierarchyAdapter(Color.class, new ColorTypeAdapter())
- .serializeNulls()
- .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
- .create();
- }
-
- private GsonConfigInstance(Class<T> configClass, Path path, Gson gson, boolean fromBuilder) {
- super(configClass);
- this.path = path;
- this.gson = gson;
- }
-
- @Override
- public void save() {
- try {
- YACLConstants.LOGGER.info("Saving {}...", getConfigClass().getSimpleName());
- Files.writeString(path, gson.toJson(getConfig()), StandardOpenOption.TRUNCATE_EXISTING, StandardOpenOption.CREATE);
- } catch (IOException e) {
- e.printStackTrace();
- }
- }
-
- @Override
- public void load() {
- try {
- if (Files.notExists(path)) {
- save();
- return;
- }
-
- YACLConstants.LOGGER.info("Loading {}...", getConfigClass().getSimpleName());
- setConfig(gson.fromJson(Files.readString(path), getConfigClass()));
- } catch (IOException e) {
- e.printStackTrace();
- }
- }
-
- public Path getPath() {
- return this.path;
- }
-
- private static class ConfigExclusionStrategy implements ExclusionStrategy {
- @Override
- public boolean shouldSkipField(FieldAttributes fieldAttributes) {
- return fieldAttributes.getAnnotation(ConfigEntry.class) == null;
- }
-
- @Override
- public boolean shouldSkipClass(Class<?> aClass) {
- return false;
- }
- }
-
- public static class ColorTypeAdapter implements JsonSerializer<Color>, JsonDeserializer<Color> {
- @Override
- public Color deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext) throws JsonParseException {
- return new Color(jsonElement.getAsInt(), true);
- }
-
- @Override
- public JsonElement serialize(Color color, Type type, JsonSerializationContext jsonSerializationContext) {
- return new JsonPrimitive(color.getRGB());
- }
- }
-
- /**
- * Creates a builder for a GSON config instance.
- * @param configClass the config class
- * @return a new builder
- * @param <T> the config type
- */
- public static <T> Builder<T> createBuilder(Class<T> configClass) {
- return new Builder<>(configClass);
- }
-
- public static class Builder<T> {
- private final Class<T> configClass;
- private Path path;
- private UnaryOperator<GsonBuilder> gsonBuilder = builder -> builder
- .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
- .serializeNulls()
- .registerTypeHierarchyAdapter(Component.class, new Component.Serializer())
- .registerTypeHierarchyAdapter(Style.class, new Style.Serializer())
- .registerTypeHierarchyAdapter(Color.class, new ColorTypeAdapter());
-
- private Builder(Class<T> configClass) {
- this.configClass = configClass;
- }
-
- /**
- * Sets the file path to save and load the config from.
- */
- public Builder<T> setPath(Path path) {
- this.path = path;
- return this;
- }
-
- /**
- * Sets the GSON instance to use. Overrides all YACL defaults such as:
- * <ul>
- * <li>lower_camel_case field naming policy</li>
- * <li>null serialization</li>
- * <li>{@link Component}, {@link Style} and {@link Color} type adapters</li>
- * </ul>
- * Still respects the exclusion strategy to only serialize {@link ConfigEntry}
- * but these can be added to with setExclusionStrategies.
- *
- * @param gsonBuilder gson builder to use
- */
- public Builder<T> overrideGsonBuilder(GsonBuilder gsonBuilder) {
- this.gsonBuilder = builder -> gsonBuilder;
- return this;
- }
-
- /**
- * Sets the GSON instance to use. Overrides all YACL defaults such as:
- * <ul>
- * <li>lower_camel_case field naming policy</li>
- * <li>null serialization</li>
- * <li>{@link Component}, {@link Style} and {@link Color} type adapters</li>
- * </ul>
- * Still respects the exclusion strategy to only serialize {@link ConfigEntry}
- * but these can be added to with setExclusionStrategies.
- *
- * @param gson gson instance to be converted to a builder
- */
- public Builder<T> overrideGsonBuilder(Gson gson) {
- return this.overrideGsonBuilder(gson.newBuilder());
- }
-
- /**
- * Appends extra configuration to a GSON builder.
- * This is the intended way to add functionality to the GSON instance.
- * <p>
- * By default, YACL sets the GSON with the following options:
- * <ul>
- * <li>lower_camel_case field naming policy</li>
- * <li>null serialization</li>
- * <li>{@link Component}, {@link Style} and {@link Color} type adapters</li>
- * </ul>
- *
- * @param gsonBuilder the function to apply to the builder
- */
- public Builder<T> appendGsonBuilder(UnaryOperator<GsonBuilder> gsonBuilder) {
- this.gsonBuilder = builder -> gsonBuilder.apply(this.gsonBuilder.apply(builder));
- return this;
- }
-
- /**
- * Builds the config instance.
- * @return the built config instance
- */
- public GsonConfigInstance<T> build() {
- UnaryOperator<GsonBuilder> gsonBuilder = builder -> this.gsonBuilder.apply(builder)
- .addSerializationExclusionStrategy(new ConfigExclusionStrategy())
- .addDeserializationExclusionStrategy(new ConfigExclusionStrategy());
-
- return new GsonConfigInstance<>(configClass, path, gsonBuilder.apply(new GsonBuilder()).create(), true);
- }
- }
-}