feat(loader): Refactor loaders and metadata.

2026-06-04 10:38:19 +08:00 · 2024-01-30 18:01:36 +08:00
parent b912ea369c
commit da3d4d1fd2
114 changed files with 1868 additions and 1772 deletions
@@ -0,0 +1,135 @@
+# EasyConfiguration-YAML
+
+YAML file-based implementation, compatible with all Java environments.
+
+## Dependencies
+
+### Maven Dependency
+
+```xml
+
+<project>
+    <repositories>
+
+        <repository>
+            <!-- Using Maven Central Repository for secure and stable updates, though synchronization might be needed. -->
+            <id>maven</id>
+            <name>Maven Central</name>
+            <url>https://repo1.maven.org/maven2</url>
+        </repository>
+
+        <repository>
+            <!-- Using GitHub dependencies for real-time updates, configuration required (recommended). -->
+            <id>EasyConfiguration</id>
+            <name>GitHub Packages</name>
+            <url>https://maven.pkg.github.com/CarmJos/EasyConfiguration</url>
+        </repository>
+
+    </repositories>
+</project>
+```
+
+```xml
+
+<project>
+    <dependencies>
+        <dependency>
+            <groupId>cc.carm.lib</groupId>
+            <artifactId>easyconfiguration-yaml</artifactId>
+            <version>[LATEST RELEASE]</version>
+            <scope>compile</scope>
+        </dependency>
+    </dependencies>
+</project>
+```
+
+### Gradle Dependency
+
+```groovy
+repositories {
+
+    // Using Maven Central Repository for secure and stable updates, though synchronization might be needed.
+    mavenCentral()
+
+    // Using GitHub dependencies for real-time updates, configuration required (recommended).
+    maven { url 'https://maven.pkg.github.com/CarmJos/EasyConfiguration' }
+
+}
+```
+
+```groovy
+dependencies {
+    api "cc.carm.lib:easyconfiguration-yaml:[LATEST RELEASE]"
+}
+```
+
+## Example file format
+```yaml
+version: 1.0.0
+
+test-save: false
+
+test-number: 6161926779561752576
+
+test-enum: DAYS
+
+# Section类型数据测试
+user: # Section数据也支持InlineComment注释
+  name: '35882'
+  info:
+    uuid: 554b79f1-7c39-4960-82d1-5514c9734417
+
+uuid-value: 9a86663e-2fc7-4851-a423-c7e5d8e94a47 # This is an inline comment
+
+sub:
+  that:
+    operators: []
+
+# [ID - UUID]对照表
+
+# 用于测试Map类型的解析与序列化保存
+users:
+  '1': 1c055bdd-c9d1-4931-8270-3d162247f38a
+  '2': 934e2b05-2417-424e-80fd-fe58c6725837
+  '3': 442949a2-8345-4210-a87b-593d7168980e
+  '4': 5c015453-4b5b-42e3-ad87-b9498f2dfeab
+  '5': 8f9640e7-0fbd-4f73-b737-f0b707215e71
+
+# Inner Test
+inner:
+  inner-value: 51.223503560658166
+
+class-value: 1.0
+
+test:
+  # Section类型数据测试
+  user: # Section数据也支持InlineComment注释
+    name: Carm
+    info:
+      uuid: 3d1ef2a0-a38b-44f3-b15f-8e3b22cb8cc6
+
+# 以下内容用于测试序列化
+model-test:
+  some-model:
+    ==: SomeModel
+    num: 855
+    name: 4f6b7
+  any-model:
+    ==: AnyModel
+    name: 63d05
+    state: false
+  models:
+    - name: 481f3
+      state: true
+    - name: fcf3e
+      state: false
+    - name: '14e50'
+      state: false
+  model-map:
+    a:
+      name: 1fb9b
+      state: false
+    b:
+      name: 5486f
+      state: false
+```
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>easyconfiguration-parent</artifactId>
+        <groupId>cc.carm.lib</groupId>
+        <version>3.9.1</version>
+        <relativePath>../../pom.xml</relativePath>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+    <properties>
+        <maven.compiler.source>${project.jdk.version}</maven.compiler.source>
+        <maven.compiler.target>${project.jdk.version}</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
+    </properties>
+
+    <artifactId>easyconfiguration-yaml</artifactId>
+    <packaging>jar</packaging>
+
+    <dependencies>
+
+        <dependency>
+            <groupId>${project.parent.groupId}</groupId>
+            <artifactId>easyconfiguration-core</artifactId>
+            <version>${project.parent.version}</version>
+            <scope>compile</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>cc.carm.lib</groupId>
+            <artifactId>yamlcommentwriter</artifactId>
+            <version>1.0.1</version>
+            <scope>compile</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>${project.parent.groupId}</groupId>
+            <artifactId>easyconfiguration-demo</artifactId>
+            <version>${project.parent.version}</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.bspfsystems</groupId>
+            <artifactId>yamlconfiguration</artifactId>
+            <version>2.0.1</version>
+            <scope>compile</scope>
+        </dependency>
+
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+
+
+</project>
@@ -0,0 +1,36 @@
+package cc.carm.lib.configuration;
+
+import cc.carm.lib.configuration.yaml.YAMLConfigProvider;
+
+import java.io.File;
+import java.io.IOException;
+
+public class EasyConfiguration {
+    
+    private EasyConfiguration() {
+    }
+
+    public static YAMLConfigProvider from(File file, String source) {
+        YAMLConfigProvider provider = new YAMLConfigProvider(file);
+        try {
+            provider.initializeFile(source);
+            provider.initializeConfig();
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+        return provider;
+    }
+
+    public static YAMLConfigProvider from(File file) {
+        return from(file, file.getName());
+    }
+
+    public static YAMLConfigProvider from(String fileName) {
+        return from(fileName, fileName);
+    }
+
+    public static YAMLConfigProvider from(String fileName, String source) {
+        return from(new File(fileName), source);
+    }
+
+}
@@ -0,0 +1,90 @@
+package cc.carm.lib.configuration.yaml;
+
+import cc.carm.lib.configuration.source.comment.ConfigurationComments;
+import cc.carm.lib.configuration.core.source.impl.FileConfigProvider;
+import cc.carm.lib.yamlcommentupdater.CommentedYAML;
+import cc.carm.lib.yamlcommentupdater.CommentedYAMLWriter;
+import org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection;
+import org.bspfsystems.yamlconfiguration.file.FileConfiguration;
+import org.bspfsystems.yamlconfiguration.file.YamlConfiguration;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.io.File;
+import java.util.List;
+import java.util.Set;
+
+public class YAMLConfigProvider extends FileConfigProvider<YAMLSectionWrapper> implements CommentedYAML {
+
+    protected final @NotNull ConfigurationComments comments = new ConfigurationComments();
+    protected YamlConfiguration configuration;
+    protected ConfigInitializer<YAMLConfigProvider> initializer;
+
+    public YAMLConfigProvider(@NotNull File file) {
+        super(file);
+    }
+
+    public void initializeConfig() {
+        ConfigurationOptions
+        this.configuration = YamlConfiguration.loadConfiguration(file);
+        this.initializer = new ConfigInitializer<>(this);
+    }
+
+    @Override
+    public @NotNull YAMLSectionWrapper getConfiguration() {
+        return YAMLSectionWrapper.of(configuration);
+    }
+
+    @Override
+    protected void onReload() throws Exception {
+        configuration.load(getFile());
+    }
+
+    @Override
+    public @NotNull ConfigurationComments getComments() {
+        return this.comments;
+    }
+
+    @Override
+    public void save() throws Exception {
+        try {
+            CommentedYAMLWriter.writeWithComments(this, this.file);
+        } catch (Exception ex) {
+            configuration.save(file);
+            throw ex;
+        }
+    }
+
+    @Override
+    public @NotNull ConfigInitializer<YAMLConfigProvider> getInitializer() {
+        return this.initializer;
+    }
+
+    @Override
+    public String serializeValue(@NotNull String key, @NotNull Object value) {
+        FileConfiguration temp = new YamlConfiguration();
+        temp.set(key, value);
+        return temp.saveToString();
+    }
+
+    @Override
+    public Set<String> getKeys(@Nullable String sectionKey, boolean deep) {
+        if (sectionKey == null) return configuration.getKeys(deep);
+
+        ConfigurationSection section = configuration.getConfigurationSection(sectionKey);
+        if (section == null) return null;
+
+        return section.getKeys(deep);
+    }
+
+    @Override
+    public @Nullable Object getValue(@NotNull String key) {
+        return configuration.get(key);
+    }
+
+    @Override
+    public @Nullable List<String> getHeaderComments(@Nullable String key) {
+        return comments.getHeaderComment(key);
+    }
+
+}
@@ -0,0 +1,88 @@
+package cc.carm.lib.configuration.yaml;
+
+import org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+public class YAMLSectionWrapper implements ConfigurationWrapper<ConfigurationSection> {
+
+    private final ConfigurationSection section;
+
+    private YAMLSectionWrapper(ConfigurationSection section) {
+        this.section = section;
+    }
+
+    @Contract("!null->!null")
+    public static @Nullable YAMLSectionWrapper of(@Nullable ConfigurationSection section) {
+        return section == null ? null : new YAMLSectionWrapper(section);
+    }
+
+    @Override
+    public @NotNull ConfigurationSection getSource() {
+        return this.section;
+    }
+
+    @Override
+    public @NotNull Set<String> getKeys(boolean deep) {
+        return new LinkedHashSet<>(section.getKeys(deep));
+    }
+
+    @Override
+    public @NotNull Map<String, Object> getValues(boolean deep) {
+        return section.getValues(deep);
+    }
+
+    @Override
+    public void set(@NotNull String path, @Nullable Object value) {
+        this.section.set(path, value);
+    }
+
+    @Override
+    public boolean contains(@NotNull String path) {
+        return this.section.contains(path);
+    }
+
+    @Override
+    public @Nullable Object get(@NotNull String path) {
+        return this.section.get(path);
+    }
+
+    @Override
+    public boolean isList(@NotNull String path) {
+        return this.section.isList(path);
+    }
+
+    @Override
+    public @Nullable List<?> getList(@NotNull String path) {
+        return this.section.getList(path);
+    }
+
+    @Override
+    public boolean isConfigurationSection(@NotNull String path) {
+        return this.section.isConfigurationSection(path);
+    }
+
+    @Override
+    public @Nullable YAMLSectionWrapper getConfigurationSection(@NotNull String path) {
+        return of(this.section.getConfigurationSection(path));
+    }
+
+    @Nullable
+    public <T extends ConfigurationSerializable> T getSerializable(@NotNull String path, @NotNull Class<T> clazz) {
+        return getSerializable(path, clazz, null);
+    }
+
+    @Nullable
+    @Contract("_, _, !null -> !null")
+    public <T extends ConfigurationSerializable> T getSerializable(@NotNull String path, @NotNull Class<T> clazz, @Nullable T defaultValue) {
+        return this.section.getSerializable(path, clazz, defaultValue);
+    }
+
+}
@@ -0,0 +1,28 @@
+package cc.carm.lib.configuration.yaml;
+
+import cc.carm.lib.configuration.value.ValueManifest;
+import cc.carm.lib.configuration.value.impl.CachedConfigValue;
+import cc.carm.lib.configuration.yaml.builder.YAMLConfigBuilder;
+import org.jetbrains.annotations.NotNull;
+
+public abstract class YAMLValue<T> extends CachedConfigValue<T> {
+
+    public static @NotNull YAMLConfigBuilder builder() {
+        return new YAMLConfigBuilder();
+    }
+
+    public YAMLValue(@NotNull ValueManifest<T> manifest) {
+        super(manifest);
+    }
+
+    public YAMLConfigProvider getYAMLProvider() {
+        ConfigurationProvider<?> provider = getProvider();
+        if (provider instanceof YAMLConfigProvider) return (YAMLConfigProvider) getProvider();
+        else throw new IllegalStateException("Provider is not a YamlConfigProvider");
+    }
+
+    public YAMLSectionWrapper getYAMLConfig() {
+        return getYAMLProvider().getConfiguration();
+    }
+
+}
@@ -0,0 +1,13 @@
+package cc.carm.lib.configuration.yaml.builder;
+
+import cc.carm.lib.configuration.core.builder.AbstractConfigBuilder;
+import cc.carm.lib.configuration.yaml.YAMLConfigProvider;
+
+public abstract class AbstractYAMLBuilder<T, B extends AbstractYAMLBuilder<T, B>>
+        extends AbstractConfigBuilder<T, B, YAMLConfigProvider> {
+
+    public AbstractYAMLBuilder() {
+        super(YAMLConfigProvider.class);
+    }
+
+}
@@ -0,0 +1,14 @@
+package cc.carm.lib.configuration.yaml.builder;
+
+import cc.carm.lib.configuration.core.builder.ConfigBuilder;
+import cc.carm.lib.configuration.yaml.builder.serializable.SerializableBuilder;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
+import org.jetbrains.annotations.NotNull;
+
+public class YAMLConfigBuilder extends ConfigBuilder {
+
+    public <V extends ConfigurationSerializable> @NotNull SerializableBuilder<V> ofSerializable(@NotNull Class<V> valueClass) {
+        return new SerializableBuilder<>(valueClass);
+    }
+
+}
@@ -0,0 +1,29 @@
+package cc.carm.lib.configuration.yaml.builder.serializable;
+
+import cc.carm.lib.configuration.yaml.builder.AbstractYAMLBuilder;
+import cc.carm.lib.configuration.yaml.value.ConfiguredSerializable;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
+import org.jetbrains.annotations.NotNull;
+
+public class SerializableBuilder<T extends ConfigurationSerializable>
+        extends AbstractYAMLBuilder<T, SerializableBuilder<T>> {
+
+    protected final @NotNull Class<T> valueClass;
+
+    public SerializableBuilder(@NotNull Class<T> valueClass) {
+        this.valueClass = valueClass;
+    }
+
+    @Override
+    protected @NotNull SerializableBuilder<T> getThis() {
+        return this;
+    }
+
+    @Override
+    public @NotNull ConfiguredSerializable<T> build() {
+        return new ConfiguredSerializable<>(buildManifest(), this.valueClass);
+    }
+
+
+}
+
@@ -0,0 +1,49 @@
+package cc.carm.lib.configuration.yaml.value;
+
+import cc.carm.lib.configuration.value.ValueManifest;
+import cc.carm.lib.configuration.yaml.YAMLValue;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public class ConfiguredSerializable<T extends ConfigurationSerializable> extends YAMLValue<T> {
+
+    public static <V extends ConfigurationSerializable> ConfiguredSerializable<V> of(@NotNull Class<V> valueClass) {
+        return of(valueClass, null);
+    }
+
+    public static <V extends ConfigurationSerializable> ConfiguredSerializable<V> of(@NotNull Class<V> valueClass,
+                                                                                     @Nullable V defaultValue) {
+        return builder().ofSerializable(valueClass).defaults(defaultValue).build();
+    }
+
+    protected final @NotNull Class<T> valueClass;
+
+    public ConfiguredSerializable(@NotNull ValueManifest<T> manifest, @NotNull Class<T> valueClass) {
+        super(manifest);
+        this.valueClass = valueClass;
+    }
+
+    @Override
+    public @Nullable T get() {
+        if (!isExpired()) return getCachedOrDefault();
+
+        try {
+            // 若未出现错误，则直接更新缓存并返回。
+            return updateCache(getYAMLConfig().getSerializable(getConfigPath(), valueClass, getDefaultValue()));
+        } catch (Exception e) {
+            // 出现了解析错误，提示并返回默认值。
+            e.printStackTrace();
+            return getDefaultValue();
+        }
+
+    }
+
+    @Override
+    public void set(@Nullable T value) {
+        updateCache(value);
+        setValue(value);
+    }
+
+
+}
@@ -0,0 +1,54 @@
+package config;
+
+import cc.carm.lib.configuration.EasyConfiguration;
+import cc.carm.lib.configuration.demo.tests.ConfigurationTest;
+import cc.carm.lib.configuration.demo.tests.model.AbstractModel;
+import cc.carm.lib.configuration.yaml.YAMLConfigProvider;
+import config.model.AnyModel;
+import config.model.SomeModel;
+import config.source.ModelConfiguration;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization;
+import org.junit.Test;
+
+import java.io.IOException;
+
+public class DemoConfigTest {
+
+    static {
+        ConfigurationSerialization.registerClass(SomeModel.class);
+        ConfigurationSerialization.registerClass(AnyModel.class);
+    }
+
+    protected final YAMLConfigProvider provider = EasyConfiguration.from("target/config.yml", "test/test2/config.yml");
+
+    @Test
+    public void onTest() {
+
+        ConfigurationTest.testDemo(this.provider);
+        ConfigurationTest.testInner(this.provider);
+
+        testSerialization(this.provider);
+
+        ConfigurationTest.save(this.provider);
+    }
+
+
+    public static void testSerialization(YAMLConfigProvider provider) {
+        provider.initialize(ModelConfiguration.class);
+        System.out.println("----------------------------------------------------");
+
+        AbstractModel someModel = ModelConfiguration.SOME_MODEL.get();
+        if (someModel != null) System.out.println(someModel.getName());
+
+        AbstractModel anyModel = ModelConfiguration.ANY_MODEL.get();
+        if (anyModel != null) System.out.println(anyModel.getName());
+
+        ModelConfiguration.MODELS.forEach(System.out::println);
+        ModelConfiguration.MODEL_MAP.forEach((v, anyModel1) -> System.out.println(v + " -> " + anyModel1.toString()));
+
+
+        System.out.println("----------------------------------------------------");
+    }
+
+
+}
@@ -0,0 +1,50 @@
+package config.model;
+
+import cc.carm.lib.configuration.demo.tests.model.AbstractModel;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
+import org.bspfsystems.yamlconfiguration.serialization.SerializableAs;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.TestOnly;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.UUID;
+
+@SerializableAs("AnyModel")
+public class AnyModel extends AbstractModel implements ConfigurationSerializable {
+
+    public final boolean bool;
+
+    public AnyModel(@NotNull String name, boolean bool) {
+        super(name);
+        this.bool = bool;
+    }
+
+    @Override
+    public String toString() {
+        return "AnyModel{" +
+                "name='" + name + '\'' +
+                ", bool=" + bool +
+                '}';
+    }
+
+    @Override
+    public @NotNull Map<String, Object> serialize() {
+        Map<String, Object> map = new HashMap<>();
+        map.put("name", name);
+        map.put("state", bool);
+        return map;
+    }
+
+    public static AnyModel random() {
+        return new AnyModel(UUID.randomUUID().toString().substring(0, 5), Math.random() > 0.5);
+    }
+
+
+    @TestOnly
+    public static AnyModel deserialize(Map<String, ?> args) {
+        return new AnyModel((String) args.get("name"), (Boolean) args.get("state"));
+    }
+
+
+}
@@ -0,0 +1,50 @@
+package config.model;
+
+import cc.carm.lib.configuration.demo.tests.model.AbstractModel;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
+import org.bspfsystems.yamlconfiguration.serialization.SerializableAs;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.TestOnly;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.UUID;
+
+@SerializableAs("SomeModel")
+public class SomeModel extends AbstractModel implements ConfigurationSerializable {
+
+    public final int num;
+
+    public SomeModel(@NotNull String name, int num) {
+        super(name);
+        this.num = num;
+    }
+
+    @Override
+    public String toString() {
+        return "SomeModel{" +
+                "name='" + name + '\'' +
+                ", num=" + num +
+                '}';
+    }
+
+    @Override
+    public @NotNull Map<String, Object> serialize() {
+        Map<String, Object> map = new HashMap<>();
+        map.put("name", name);
+        map.put("num", num);
+        return map;
+    }
+
+    public static SomeModel random() {
+        return new SomeModel(UUID.randomUUID().toString().substring(0, 5), (int) (Math.random() * 1000));
+    }
+
+
+    @TestOnly
+    public static SomeModel deserialize(Map<String, ?> args) {
+        return new SomeModel((String) args.get("name"), (Integer) args.get("num"));
+    }
+
+
+}
@@ -0,0 +1,43 @@
+package config.source;
+
+import cc.carm.lib.configuration.source.Configuration;
+import cc.carm.lib.configuration.annotation.ConfigPath;
+import cc.carm.lib.configuration.annotation.HeaderComment;
+import cc.carm.lib.configuration.value.ConfigValue;
+import cc.carm.lib.configuration.value.standard.ConfiguredList;
+import cc.carm.lib.configuration.value.standard.ConfiguredMap;
+import cc.carm.lib.configuration.value.standard.ConfiguredSectionMap;
+import cc.carm.lib.configuration.demo.tests.model.AbstractModel;
+import cc.carm.lib.configuration.yaml.value.ConfiguredSerializable;
+import config.model.AnyModel;
+import config.model.SomeModel;
+
+@HeaderComment("以下内容用于测试序列化")
+@ConfigPath("model-test")
+public class ModelConfiguration implements Configuration {
+
+    public static final ConfigValue<? extends AbstractModel> SOME_MODEL = ConfiguredSerializable.of(
+            SomeModel.class, SomeModel.random()
+    );
+
+    public static final ConfigValue<? extends AbstractModel> ANY_MODEL = ConfiguredSerializable.of(
+            AnyModel.class, AnyModel.random()
+    );
+
+    public static final ConfiguredList<AnyModel> MODELS = ConfiguredList.builderOf(AnyModel.class)
+            .fromMap()
+            .parseValue(AnyModel::deserialize).serializeValue(AnyModel::serialize)
+            .defaults(AnyModel.random(), AnyModel.random(), AnyModel.random())
+            .build();
+
+    public static final ConfiguredSectionMap<String, AnyModel> MODEL_MAP = ConfiguredMap.builderOf(String.class, AnyModel.class)
+            .asLinkedMap().fromSection()
+            .parseValue(v -> new AnyModel(v.getString("name", "EMPTY"), v.getBoolean("state", false)))
+            .serializeValue(AnyModel::serialize)
+            .defaults(m -> {
+                m.put("a", AnyModel.random());
+                m.put("b", AnyModel.random());
+            })
+            .build();
+
+}
@@ -0,0 +1,17 @@
+package sample;
+
+import cc.carm.lib.configuration.EasyConfiguration;
+
+public class Sample {
+
+    public static void main(String[] args) {
+        // 1. Make a configuration provider from a file.
+        ConfigurationProvider<?> provider = EasyConfiguration.from("config.yml");
+        // 2. Initialize the configuration classes or instances.
+        provider.initialize(SampleConfig.class);
+        // 3. Enjoy using the configuration!
+        SampleConfig.ENABLED.set(false);
+        System.out.println("Your name is " + SampleConfig.INFO.NAME.getNotNull() + " !");
+    }
+
+}
@@ -0,0 +1,34 @@
+package sample;
+
+import cc.carm.lib.configuration.source.Configuration;
+import cc.carm.lib.configuration.annotation.ConfigPath;
+import cc.carm.lib.configuration.annotation.HeaderComment;
+import cc.carm.lib.configuration.annotation.InlineComment;
+import cc.carm.lib.configuration.value.standard.ConfiguredList;
+import cc.carm.lib.configuration.value.standard.ConfiguredValue;
+
+import java.util.UUID;
+
+@HeaderComment("Configurations for sample")
+public interface SampleConfig extends Configuration {
+
+    @InlineComment("Enabled?") // Inline comment
+    ConfiguredValue<Boolean> ENABLED = ConfiguredValue.of(true);
+
+    ConfiguredList<UUID> UUIDS = ConfiguredList.builderOf(UUID.class).fromString()
+            .parseValue(UUID::fromString).serializeValue(UUID::toString)
+            .defaults(
+                    UUID.fromString("00000000-0000-0000-0000-000000000000"),
+                    UUID.fromString("00000000-0000-0000-0000-000000000001")
+            ).build();
+
+    interface INFO extends Configuration {
+
+        @HeaderComment("Configure your name!") // Header comment
+        ConfiguredValue<String> NAME = ConfiguredValue.of("Joker");
+
+        @ConfigPath("year") // Custom path
+        ConfiguredValue<Integer> AGE = ConfiguredValue.of(24);
+
+    }
+}
@@ -0,0 +1,2 @@
+version: 1.0
+test-save: false