Config Mapper

Use this library to map between configurations and plain java objects. The difference between this project and others, like jackson, is that you can configure what is required in what position and so on. This allows you to write your own parser for the configuration and then map it into your objects.

An example of this is the art-framework which uses this library to parse and validate its configuration strings.

• As a Dependency
  • Gradle
  • Maven
• Usage
• Bukkit Mapper

As a Dependency

Include config-mapper in your project and shade it via gradle or maven.

Gradle

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    implementation group: 'net.silthus.config-mapper', name: 'core', version: '1.6.1'
}

Maven

<project>
    <repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
    </repositories>
    <dependencies>
        <dependency>
            <groupId>net.silthus.config-mapper</groupId>
            <artifactId>core</artifactId>
            <version>1.6.1</version>
        </dependency>
    </dependencies>
</project>

Usage

You can pass any class to the config mapper and create a ConfigMap which can then be applied to your objects.

try {
    // 1. create a config map from all annotated @ConfigOption fields in your class
    ConfigMap configMap = ConfigMap.of(YourClass.class);
    // 2. load the values that should be mapped to the fields
    //    this is the part where you can create your custom parser
    //    or use one of the parsers that comes with this project
    // ~ the ConfigMap object is immutable so we need to reassign it
    configMap = configMap.with(
        KeyValuePair.of("my_config_key", "my-value"),
        KeyValuePair.of("second_key", 2.0)
    );
    // 3. apply all values to your object and check if all prerequesites are met (like required settings)
    YourClass config = configMap.applyTo(new YourClass());
} catch(ConfigurationException e) {
    // something went wrong while scanning your class for config fields
    // the error message contains details about the error
}

public static class YourClass {

    // make sure your class has a public parameterless constructor
    // or use the ConfigMap.of(Class<?>, Supplier<?>) method
    public YourClass() {}

    @ConfigOption
    private String myConfigKey = "foobar";
    @ConfigOption(required = true)
    private double secondKey;
}

Bukkit Mapper

You can use this project to map ConfigurationSection configs into your object. You need to depend on the subproject net.silthus.config-mapper:bukkit and shade it into your plugin.

Then use the BukkitConfigMap.of(...) methods instead of the ConfigMap to create your config. This will provide you with a new method with(ConfigurationSection) to fetch values from your config.

    @SneakyThrows
    @Test
    @DisplayName("should map configuration section to object")
    void shouldMapConfigSectionToObject() {

        MemoryConfiguration config = new MemoryConfiguration();
        config.set("required", "foobar");
        config.set("val", 10);

        BukkitConfig result = BukkitConfigMap.of(BukkitConfig.class)
                .with(config)
                .applyTo(new BukkitConfig());

        assertThat(result).extracting(
                BukkitConfig::getRequired,
                BukkitConfig::getVal
        ).contains("foobar", 10);
    }

    @Data
    public static class BukkitConfig {

        @ConfigOption(required = true)
        private String required;
        @ConfigOption
        private int val = 5;
    }