BukkitJSONSerializer

A JSON serialize/deserialize util for bukkit's ConfigurationSerialization.

Usage

Basic usage

We cloud use BukkitJSONSerializer#serializeToJSON(ConfigurationSerializable) to serialize a object to JSON.

        Location location = new Location(Bukkit.getWorlds().get(0), -100.5, 100, 105.5);
        String serialized = BukkitJSONSerializer.serializeToJSON(location);
        // serialized -> {"world":"world","x":-100.5,"y":100,"z":105.5,"yaw":0.0,"pitch":0.0}

When we need to read the object, just use BukkitJSONSerializer#deserializeSON(json,typeClass) to deserialize the JSON string.

        Location deserialized=BukkitJSONSerializer.deserializeJSON(serialized,Location.class);

Or use BukkitJSONSerializer#deserializeSON(json,typeClass,defaultValue) if we need a default value.

JSONSerializable class

This project provided an interface JSONSerializable which provided a default method to serialize itself to JSON.

public interface JSONSerializable extends ConfigurationSerializable {

    default @NotNull String serializeToJSON() {
        return BukkitJSONSerializer.serializeToJSON(this);
    }

}

Dependency Usage

Maven dependency


<project>
    <repositories>

        <repository>
            <!--Using central repository-->
            <id>maven</id>
            <name>Maven Central</name>
            <url>https://repo1.maven.org/maven2</url>
        </repository>

        <repository>
            <!--Using github repository-->
            <id>BukkitJSONSerializer</id>
            <url>https://raw.githubusercontent.com/CarmJos/BukkitJSONSerializer/repo/</url>
        </repository>

    </repositories>

    <dependencies>

        <dependency>
            <groupId>cc.carm.lib</groupId>
            <artifactId>bukkitjsonserializer</artifactId>
            <version>[LATEST RELEASE]</version>
            <scope>compile</scope>
        </dependency>

    </dependencies>

</project>

Gradle dependency

repositories {

    mavenCentral() // Using central repository.

    // Using github repositories.
    maven { url 'https://raw.githubusercontent.com/CarmJos/BukkitJSONSerializer/repo/' }

}

dependencies {
    api "cc.carm.lib:bukkitjsonserializer:[LATEST RELEASE]"
}

Open Source License.

The project using GNU LESSER GENERAL PUBLIC LICENSE .

3.2 KiB Raw Blame History