serializer) {
75 | try (BufferedReader reader = new BufferedReader(new FileReader(file))) {
76 | String content = Utils.readFromFile(reader);
77 | return serialize(clazz, content, serializer);
78 | } catch (IOException e) {
79 | try {
80 | return clazz.getDeclaredConstructor().newInstance();
81 | } catch (InvocationTargetException |
82 | InstantiationException |
83 | IllegalAccessException |
84 | NoSuchMethodException ex) {
85 | throw new RuntimeException("Failed to parse config", ex);
86 | }
87 | }
88 | }
89 |
90 | /**
91 | * Cast the given config content to an instance of the config whose type is specified by the "clazz" parameter, using the cached serializer.
92 | * If the serializer for this class is not cached, a {@link RuntimeException} is thrown.
93 | *
94 | * @param clazz the class of the config instance type
95 | * @param content the content of the config as a string
96 | * @param the type of the config instance
97 | * @return an instance of the config
98 | */
99 | T serializeCached(Class clazz, String content);
100 |
101 | /**
102 | * Cast the given config content to an instance of the config whose type is specified by the "clazz" parameter and cache the serializer for the given type.
103 | *
104 | * @param clazz the class of the config instance type
105 | * @param file the content of the config as a file
106 | * @param the type of the config instance
107 | * @return an instance of the config
108 | */
109 | default T serializeCached(Class clazz, File file) {
110 | try (BufferedReader reader = new BufferedReader(new FileReader(file))) {
111 | String content = Utils.readFromFile(reader);
112 | return serializeCached(clazz, content);
113 | } catch (IOException e) {
114 | try {
115 | return clazz.getDeclaredConstructor().newInstance();
116 | } catch (InvocationTargetException |
117 | InstantiationException |
118 | IllegalAccessException |
119 | NoSuchMethodException ex) {
120 | throw new RuntimeException("Failed to parse config", ex);
121 | }
122 | }
123 | }
124 |
125 | /**
126 | * Convert the given config instance to a string representing the config content and cache the deserializer for the given type.
127 | *
128 | * @param clazz the class of the config instance type
129 | * @param content the content of the config as an instance
130 | * @param deserializer the deserializer used to parse the config instance
131 | * @param the type of the config instance
132 | * @return the content of the config as a string
133 | */
134 | String deserialize(Class clazz, T content, Function deserializer);
135 |
136 | /**
137 | * Convert the given config instance to a string representing the config content, using the cached deserializer.
138 | * If the deserializer for this class is not cached, a {@link RuntimeException} is thrown.
139 | *
140 | * @param clazz the class of the config instance type
141 | * @param content the content of the config as an instance
142 | * @param the type of the config instance
143 | * @return the content of the config as a string
144 | */
145 | String deserializeCached(Class clazz, T content);
146 |
147 | /**
148 | * Write the given config instance to the target file as a string representing the config content and cache the deserializer for the given type.
149 | *
150 | * @param clazz the class of the config instance type
151 | * @param content the content of the config as an instance
152 | * @param deserializer the deserializer used to parse the config instance
153 | * @param file the target file the config is written to
154 | * @param the type of the config instance
155 | */
156 | default void deserializeAndWrite(Class clazz, T content, Function deserializer, File file) {
157 | String string = deserialize(clazz, content, deserializer);
158 | Utils.writeToConfigFile(file, string);
159 | }
160 |
161 | /**
162 | * Write the given config instance to the target file as a string representing the config content, using the cached deserializer.
163 | * If the deserializer for this class is not cached, a {@link RuntimeException} is thrown.
164 | *
165 | * @param clazz the class of the config instance type
166 | * @param content the content of the config as an instance
167 | * @param file the target file the config is written to
168 | * @param the type of the config instance
169 | */
170 | default void deserializeAndWriteCached(Class clazz, T content, File file) {
171 | String string = deserializeCached(clazz, content);
172 | Utils.writeToConfigFile(file, string);
173 | }
174 |
175 | @ApiStatus.Internal
176 | class Utils {
177 | private static @NotNull String readFromFile(@NotNull BufferedReader reader) throws IOException {
178 | StringBuilder stringBuilder = new StringBuilder();
179 | String line;
180 | String ls = System.getProperty("line.separator");
181 | while ((line = reader.readLine()) != null) {
182 | stringBuilder.append(line);
183 | stringBuilder.append(ls);
184 | }
185 | stringBuilder.deleteCharAt(stringBuilder.length() - 1);
186 | reader.close();
187 |
188 | return stringBuilder.toString();
189 | }
190 |
191 | private static void writeToConfigFile(@NotNull File file, String string) {
192 | if (!file.exists()) {
193 | try {
194 | file.createNewFile();
195 | } catch (IOException e) {
196 | throw new RuntimeException("Failed to create file", e);
197 | }
198 | }
199 | try (FileWriter writer = new FileWriter(file)) {
200 | writer.write(""); // Empty the file
201 | writer.write(string);
202 | writer.flush();
203 | } catch (IOException e) {
204 | throw new RuntimeException("Failed to write config");
205 | }
206 | }
207 | }
208 | }
209 |
--------------------------------------------------------------------------------
/src/main/java/io/github/prismwork/prismconfig/api/config/DefaultDeserializers.java:
--------------------------------------------------------------------------------
1 | package io.github.prismwork.prismconfig.api.config;
2 |
3 | import io.github.prismwork.prismconfig.impl.config.DefaultDeserializersImpl;
4 |
5 | import java.util.function.Function;
6 |
7 | /**
8 | * The default deserializers Prism Config provides.
9 | * For now there are three: JSON, JSON5 and TOML (0.4.0).
10 | *
11 | * @since 0.1.0
12 | */
13 | @SuppressWarnings("unused")
14 | public interface DefaultDeserializers {
15 | /**
16 | * Lazily get the instance of {@link DefaultDeserializers}.
17 | *
18 | * @return an instance of {@link DefaultDeserializers}.
19 | * If the instance cache does not exist, it will try to create one.
20 | */
21 | static DefaultDeserializers getInstance() {
22 | if (DefaultDeserializersImpl.INSTANCE_CACHE != null) {
23 | return DefaultDeserializersImpl.INSTANCE_CACHE;
24 | }
25 | return new DefaultDeserializersImpl();
26 | }
27 |
28 | /**
29 | * Returns a JSON deserializer for the given config class.
30 | *
31 | * @param clazz the config class the deserializer is going to handle
32 | * @param the type of the config class
33 | * @return the JSON deserializer for the given config class
34 | */
35 | Function json(Class clazz);
36 |
37 | /**
38 | * Returns a JSON5 deserializer for the given config class.
39 | *
40 | * @param clazz the config class the deserializer is going to handle
41 | * @param the type of the config class
42 | * @return the JSON5 deserializer for the given config class
43 | */
44 | Function json5(Class clazz);
45 |
46 | /**
47 | * Returns a TOML (0.4.0) deserializer for the given config class.
48 | *
49 | * @param clazz the config class the deserializer is going to handle
50 | * @param the type of the config class
51 | * @return the TOML deserializer for the given config class
52 | */
53 | Function toml(Class clazz);
54 | }
55 |
--------------------------------------------------------------------------------
/src/main/java/io/github/prismwork/prismconfig/api/config/DefaultSerializers.java:
--------------------------------------------------------------------------------
1 | package io.github.prismwork.prismconfig.api.config;
2 |
3 | import io.github.prismwork.prismconfig.impl.config.DefaultSerializersImpl;
4 |
5 | import java.util.function.Function;
6 |
7 | /**
8 | * The default serializers Prism Config provides.
9 | * For now there are three: JSON, JSON5 and TOML (0.4.0).
10 | *
11 | * @since 0.1.0
12 | */
13 | @SuppressWarnings("unused")
14 | public interface DefaultSerializers {
15 | /**
16 | * Lazily get the instance of {@link DefaultSerializers}.
17 | *
18 | * @return an instance of {@link DefaultSerializers}.
19 | * If the instance cache does not exist, it will try to create one.
20 | */
21 | static DefaultSerializers getInstance() {
22 | if (DefaultSerializersImpl.INSTANCE_CACHE != null) {
23 | return DefaultSerializersImpl.INSTANCE_CACHE;
24 | }
25 | return new DefaultSerializersImpl();
26 | }
27 |
28 | /**
29 | * Returns a JSON serializer for the given config class.
30 | *
31 | * @param clazz the config class the serializer is going to handle
32 | * @param the type of the config class
33 | * @return the JSON serializer for the given config class
34 | */
35 | Function json(Class clazz);
36 |
37 | /**
38 | * Returns a JSON5 serializer for the given config class.
39 | *
40 | * @param clazz the config class the serializer is going to handle
41 | * @param the type of the config class
42 | * @return the JSON5 serializer for the given config class
43 | */
44 | Function json5(Class clazz);
45 |
46 | /**
47 | * Returns a TOML (0.4.0) serializer for the given config class.
48 | *
49 | * @param clazz the config class the serializer is going to handle
50 | * @param the type of the config class
51 | * @return the TOML serializer for the given config class
52 | */
53 | Function toml(Class clazz);
54 | }
55 |
--------------------------------------------------------------------------------
/src/main/java/io/github/prismwork/prismconfig/impl/PrismConfigImpl.java:
--------------------------------------------------------------------------------
1 | package io.github.prismwork.prismconfig.impl;
2 |
3 | import io.github.prismwork.prismconfig.api.PrismConfig;
4 | import org.jetbrains.annotations.ApiStatus;
5 | import org.jetbrains.annotations.Nullable;
6 |
7 | import java.util.HashMap;
8 | import java.util.Map;
9 | import java.util.function.Function;
10 |
11 | @ApiStatus.Internal
12 | @SuppressWarnings("unchecked")
13 | public final class PrismConfigImpl implements PrismConfig {
14 | public static @Nullable PrismConfig INSTANCE_CACHE;
15 |
16 | private final Map, Function> cachedSerializers;
17 | private final Map, Function> cachedDeserializers;
18 |
19 | public PrismConfigImpl() {
20 | this.cachedSerializers = new HashMap<>();
21 | this.cachedDeserializers = new HashMap<>();
22 | PrismConfigImpl.INSTANCE_CACHE = this;
23 | }
24 |
25 | @Override
26 | public T serialize(Class clazz, String content, Function serializer) {
27 | if (!cachedSerializers.containsKey(clazz)) {
28 | cachedSerializers.put(clazz, (Function) serializer);
29 | }
30 | return serializer.apply(content);
31 | }
32 |
33 | @Override
34 | public T serializeCached(Class clazz, String content) {
35 | if (!cachedSerializers.containsKey(clazz)) throw new RuntimeException("Cached serializer not found");
36 | return (T) cachedSerializers.get(clazz).apply(content);
37 | }
38 |
39 | @Override
40 | public String deserialize(Class clazz, T content, Function deserializer) {
41 | if (!cachedDeserializers.containsKey(clazz)) {
42 | cachedDeserializers.put(clazz, (Function) deserializer);
43 | }
44 | return deserializer.apply(content);
45 | }
46 |
47 | @Override
48 | public String deserializeCached(Class clazz, T content) {
49 | if (!cachedDeserializers.containsKey(clazz)) throw new RuntimeException("Cached deserializer not found");
50 | return cachedDeserializers.get(clazz).apply(content);
51 | }
52 | }
53 |
--------------------------------------------------------------------------------
/src/main/java/io/github/prismwork/prismconfig/impl/config/DefaultDeserializersImpl.java:
--------------------------------------------------------------------------------
1 | package io.github.prismwork.prismconfig.impl.config;
2 |
3 | import blue.endless.jankson.Comment;
4 | import blue.endless.jankson.Jankson;
5 | import com.google.gson.Gson;
6 | import com.google.gson.GsonBuilder;
7 | import com.moandjiezana.toml.TomlWriter;
8 | import io.github.prismwork.prismconfig.api.config.DefaultDeserializers;
9 | import org.jetbrains.annotations.ApiStatus;
10 | import org.jetbrains.annotations.Nullable;
11 |
12 | import java.lang.reflect.Field;
13 | import java.util.HashMap;
14 | import java.util.Map;
15 | import java.util.function.Function;
16 |
17 | @ApiStatus.Internal
18 | public final class DefaultDeserializersImpl implements DefaultDeserializers {
19 | public static @Nullable DefaultDeserializers INSTANCE_CACHE;
20 |
21 | private final Gson gson;
22 | private final Jankson jankson;
23 | private final TomlWriter toml;
24 |
25 | public DefaultDeserializersImpl() {
26 | this.gson = new GsonBuilder().setPrettyPrinting().create();
27 | this.jankson = new Jankson.Builder().build();
28 | this.toml = new TomlWriter.Builder().build();
29 | DefaultDeserializersImpl.INSTANCE_CACHE = this;
30 | }
31 |
32 | @Override
33 | public Function json(Class clazz) {
34 | return gson::toJson;
35 | }
36 |
37 | @Override
38 | public Function json5(Class clazz) {
39 | return (config) -> jankson.toJson(config).toJson(true, true);
40 | }
41 |
42 | @Override
43 | public Function toml(Class clazz) {
44 | // toml4j does not support adding comments, so we will do our own, using the @Comment from Jankson
45 | return (config) -> {
46 | try {
47 | StringBuilder sb = new StringBuilder();
48 | for (Field field : clazz.getDeclaredFields()) {
49 | field.setAccessible(true); // Make protected and private fields accessible
50 | if (field.isAnnotationPresent(Comment.class)) {
51 | sb.append("# ")
52 | .append(field.getDeclaredAnnotation(Comment.class).value())
53 | .append("\n");
54 | }
55 | Map map = new HashMap<>();
56 | map.put(field.getName(), field.get(config));
57 | sb.append(toml.write(map));
58 | }
59 | return sb.toString();
60 | } catch (IllegalAccessException e) {
61 | throw new RuntimeException(e);
62 | }
63 | };
64 | }
65 | }
66 |
--------------------------------------------------------------------------------
/src/main/java/io/github/prismwork/prismconfig/impl/config/DefaultSerializersImpl.java:
--------------------------------------------------------------------------------
1 | package io.github.prismwork.prismconfig.impl.config;
2 |
3 | import blue.endless.jankson.Jankson;
4 | import blue.endless.jankson.api.SyntaxError;
5 | import com.google.gson.Gson;
6 | import com.google.gson.GsonBuilder;
7 | import com.google.gson.JsonSyntaxException;
8 | import com.moandjiezana.toml.Toml;
9 | import io.github.prismwork.prismconfig.api.config.DefaultSerializers;
10 | import org.jetbrains.annotations.ApiStatus;
11 | import org.jetbrains.annotations.Nullable;
12 |
13 | import java.lang.reflect.InvocationTargetException;
14 | import java.util.function.Function;
15 |
16 | @ApiStatus.Internal
17 | public final class DefaultSerializersImpl implements DefaultSerializers {
18 | public static @Nullable DefaultSerializers INSTANCE_CACHE;
19 |
20 | private final Gson gson;
21 | private final Jankson jankson;
22 | private final Toml toml;
23 |
24 | public DefaultSerializersImpl() {
25 | this.gson = new GsonBuilder().setPrettyPrinting().create();
26 | this.jankson = new Jankson.Builder().build();
27 | this.toml = new Toml();
28 | DefaultSerializersImpl.INSTANCE_CACHE = this;
29 | }
30 |
31 | @Override
32 | public Function json(Class clazz) {
33 | return (content) -> {
34 | try {
35 | T ret = gson.fromJson(content, clazz);
36 | if (ret == null) {
37 | return clazz.getDeclaredConstructor().newInstance();
38 | }
39 | return ret;
40 | } catch (JsonSyntaxException |
41 | InvocationTargetException |
42 | InstantiationException |
43 | IllegalAccessException |
44 | NoSuchMethodException e) {
45 | throw new RuntimeException("Failed to parse JSON", e);
46 | }
47 | };
48 | }
49 |
50 | @Override
51 | public Function json5(Class clazz) {
52 | return (content) -> {
53 | try {
54 | T ret = jankson.fromJson(content, clazz);
55 | if (ret == null) {
56 | return clazz.getDeclaredConstructor().newInstance();
57 | }
58 | return ret;
59 | } catch (SyntaxError |
60 | InvocationTargetException |
61 | InstantiationException |
62 | IllegalAccessException |
63 | NoSuchMethodException e) {
64 | throw new RuntimeException("Failed to parse JSON5", e);
65 | }
66 | };
67 | }
68 |
69 | @Override
70 | public Function toml(Class clazz) {
71 | return (content) -> {
72 | try {
73 | T ret = toml.read(content).to(clazz);
74 | if (ret == null) {
75 | return clazz.getDeclaredConstructor().newInstance();
76 | }
77 | return ret;
78 | } catch (InvocationTargetException |
79 | InstantiationException |
80 | IllegalAccessException |
81 | IllegalStateException |
82 | NoSuchMethodException e) {
83 | throw new RuntimeException("Failed to parse TOML", e);
84 | }
85 | };
86 | }
87 | }
88 |
--------------------------------------------------------------------------------
/src/main/resources/fabric.mod.json:
--------------------------------------------------------------------------------
1 | {
2 | "schemaVersion": 1,
3 | "id": "prismconfig",
4 | "version": "${version}",
5 | "name": "Prism Config",
6 | "description": "A lightweight config library for Java to let you write your config elegantly and flexibly.",
7 | "authors": [
8 | "Prismwork"
9 | ],
10 | "contact": {
11 | "homepage": "https://github.com/Prismwork/",
12 | "sources": "https://github.com/Prismwork/PrismConfig"
13 | },
14 | "license": "MIT",
15 | "environment": "*"
16 | }
--------------------------------------------------------------------------------
/src/test/java/io/github/prismwork/prismconfig/test/PrismConfigTest.java:
--------------------------------------------------------------------------------
1 | package io.github.prismwork.prismconfig.test;
2 |
3 | import blue.endless.jankson.Comment;
4 | import io.github.prismwork.prismconfig.api.PrismConfig;
5 | import io.github.prismwork.prismconfig.api.config.DefaultDeserializers;
6 | import io.github.prismwork.prismconfig.api.config.DefaultSerializers;
7 | import org.junit.jupiter.api.Test;
8 |
9 | import java.io.*;
10 |
11 | public class PrismConfigTest {
12 | @Test
13 | void testConfig() {
14 | File configFile = new File("config.json");
15 | if (!configFile.exists()) {
16 | try {
17 | configFile.createNewFile();
18 | } catch (IOException e) {
19 | throw new RuntimeException(e);
20 | }
21 | }
22 | try (BufferedReader reader = new BufferedReader(new FileReader(configFile));) {
23 | StringBuilder stringBuilder = new StringBuilder();
24 | String line;
25 | String ls = System.getProperty("line.separator");
26 | while ((line = reader.readLine()) != null) {
27 | stringBuilder.append(line);
28 | stringBuilder.append(ls);
29 | }
30 | // stringBuilder.deleteCharAt(stringBuilder.length() - 1);
31 | reader.close();
32 |
33 | String content = stringBuilder.toString();
34 | TestConfig config = PrismConfig.getInstance().serialize(
35 | TestConfig.class,
36 | content,
37 | DefaultSerializers.getInstance().json(TestConfig.class)
38 | );
39 | System.out.println(config.string);
40 | } catch (IOException e) {
41 | throw new RuntimeException(e);
42 | }
43 |
44 | File configFile1 = new File("config1.json5");
45 | if (!configFile1.exists()) {
46 | try {
47 | configFile1.createNewFile();
48 | } catch (IOException e) {
49 | throw new RuntimeException(e);
50 | }
51 | }
52 | TestConfig config1 = new TestConfig();
53 | PrismConfig.getInstance().deserializeAndWrite(
54 | TestConfig.class,
55 | config1,
56 | DefaultDeserializers.getInstance().json5(TestConfig.class),
57 | configFile1
58 | );
59 |
60 | TestConfig config2 = PrismConfig.getInstance().serialize(
61 | TestConfig.class,
62 | configFile1,
63 | DefaultSerializers.getInstance().json5(TestConfig.class)
64 | );
65 | System.out.println(config2.bool1);
66 |
67 | File configFile2 = new File("config2.toml");
68 | if (!configFile2.exists()) {
69 | try {
70 | configFile2.createNewFile();
71 | } catch (IOException e) {
72 | throw new RuntimeException(e);
73 | }
74 | }
75 | PrismConfig.getInstance().deserializeAndWrite(
76 | TestConfig.class,
77 | config2,
78 | DefaultDeserializers.getInstance().toml(TestConfig.class),
79 | configFile2
80 | );
81 | System.out.println(PrismConfig.getInstance().serialize(
82 | TestConfig.class,
83 | configFile2,
84 | DefaultSerializers.getInstance().toml(TestConfig.class)
85 | ).nested.hello);
86 | }
87 |
88 | public static class TestConfig {
89 | public boolean bool1 = false;
90 | public boolean bool2 = true;
91 | @Comment("Hello from comment")
92 | public String string = "Hi";
93 | public SimpleNested nested = new SimpleNested();
94 |
95 | public static class SimpleNested {
96 | public String hello = "Hello from nested";
97 | public int number = 114514;
98 | }
99 | }
100 | }
101 |
--------------------------------------------------------------------------------
4 |
5 | 
6 | 
7 | [][releases]
8 |
9 | **English** | [简体中文](README_ZH.md)
10 |
11 | A lightweight config library for Java to let you write your config elegantly and flexibly.
12 |
13 |