de.eldoria.jacksonbukkit.builder.JacksonPaperBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of paper Show documentation
Module for serialization on Paper based servers
The newest version!
/*
 *     SPDX-License-Identifier: MIT
 *
 *     Copyright (C) EldoriaRPG Team and Contributor
 */
package de.eldoria.jacksonbukkit.builder;

import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonSerializer;
import de.eldoria.jacksonbukkit.JacksonPaper;
import de.eldoria.jacksonbukkit.deserializer.ComponentGsonDeserializer;
import de.eldoria.jacksonbukkit.deserializer.ComponentMiniMessageDeserializer;
import de.eldoria.jacksonbukkit.serializer.ComponentGsonSerializer;
import de.eldoria.jacksonbukkit.serializer.ComponentMiniMessageSerializer;
import de.eldoria.jacksonbukkit.util.PaperFeatures;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.minimessage.MiniMessage;
import org.bukkit.configuration.serialization.ConfigurationSerializable;
import org.jetbrains.annotations.Nullable;

/**
 * Class to build a {@link JacksonPaper} module.
 */
public class JacksonPaperBuilder extends ModuleBuilder {
    private boolean legacyItemStackSerialization = false;
    private @Nullable JsonSerializer componentJsonSerializer;
    private @Nullable JsonDeserializer componentJsonDeserializer;

    /**
     * Create a new builder instance
     */
    public JacksonPaperBuilder() {
        if (PaperFeatures.HAS_MINI_MESSAGE) {
            componentJsonDeserializer = new ComponentMiniMessageDeserializer();
            componentJsonSerializer = new ComponentMiniMessageSerializer();
        } else if (PaperFeatures.HAS_ADVENTURE) {
            componentJsonSerializer = new ComponentGsonSerializer();
            componentJsonDeserializer = new ComponentGsonDeserializer();
        }
    }

    /**
     * Use legacy serializer which serializes the item stack as a map via {@link ConfigurationSerializable}.
     * 
     * This does not work if the plugin is a {@code PaperPlugin}
     *
     * @return builder instance
     */
    public JacksonPaperBuilder useLegacyItemStackSerialization() {
        legacyItemStackSerialization = true;
        return this;
    }

    /**
     * Supply a custom mini message instance to the module.
     *
     * @param miniMessage mini message instance. Providing null will disable component serialization.
     * @return builder instance
     */
    public JacksonPaperBuilder withMiniMessages(MiniMessage miniMessage) {
        this.componentJsonSerializer = new ComponentMiniMessageSerializer(miniMessage);
        this.componentJsonDeserializer = new ComponentMiniMessageDeserializer(miniMessage);
        return this;
    }

    /**
     * Use mini message for deserialization. This is the default behaviour when mini messages is present.
     *
     * @return builder instance
     */
    public JacksonPaperBuilder withMiniMessages() {
        this.componentJsonSerializer = new ComponentMiniMessageSerializer();
        this.componentJsonDeserializer = new ComponentMiniMessageDeserializer();
        return this;
    }

    @Override
    public JacksonPaper build() {
        return new JacksonPaper(hexColors, legacyItemStackSerialization, componentJsonDeserializer, componentJsonSerializer);
    }
}