xyz.jpenilla.squaremap.api.HtmlComponentSerializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of squaremap-api Show documentation

API for extending squaremap, a minimalistic and lightweight world map viewer for Minecraft servers

There is a newer version: 1.3.4

package xyz.jpenilla.squaremap.api;

import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.flattener.ComponentFlattener;
import net.kyori.adventure.text.serializer.ComponentEncoder;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
import org.jetbrains.annotations.ApiStatus;

/**
 * Safely encodes {@link Component Components} as HTML text.
 *
 * Mostly useful for marker tooltips.
 *
 * @see Squaremap#htmlComponentSerializer()
 * @since 1.2.0
 */
@DefaultQualifier(NonNull.class)
public interface HtmlComponentSerializer extends ComponentEncoder {

    /**
     * Create a new {@link HtmlComponentSerializer} using the provided {@link ComponentFlattener}.
     *
     * @param flattener component flattener
     * @return serializer
     */
    static HtmlComponentSerializer withFlattener(final ComponentFlattener flattener) {
        return ProviderHolder.HTML_SERIALIZER.create(flattener);
    }

    @ApiStatus.Internal
    interface Provider {
        HtmlComponentSerializer create(ComponentFlattener flattener);
    }

}