Package net.kyori.adventure.serializer.configurate3

Interface ConfigurateComponentSerializer

All Superinterfaces:
net.kyori.adventure.text.serializer.ComponentSerializer<net.kyori.adventure.text.Component,​net.kyori.adventure.text.Component,​ninja.leaping.configurate.ConfigurationNode>
public interface ConfigurateComponentSerializer
extends net.kyori.adventure.text.serializer.ComponentSerializer<net.kyori.adventure.text.Component,​net.kyori.adventure.text.Component,​ninja.leaping.configurate.ConfigurationNode>
A serializer that will output to Configurate ConfigurationNodes.

This serializer only modifies its own serializer collection. To add to another collection, use an existing serializer instance to populate that collection. Serializers are added for every Adventure data type.

The preferred way to use Configurate integration is by registering this serializer's type serializers with a separate

Since:
4.0.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type Interface Description
    static interface  ConfigurateComponentSerializer.Builder
    A builder for a configurate serializer instance.

  • Method Summary

    Modifier and Type Method Description
    @NotNull ninja.leaping.configurate.objectmapping.serialize.TypeSerializerCollection addSerializersTo​(@NotNull ninja.leaping.configurate.objectmapping.serialize.TypeSerializerCollection collection)
    Populate an existing serializer collection with Adventure serializers.
    static @NotNull ConfigurateComponentSerializer.Builder builder()
    Create a new builder for a customized Configurate serializer.
    static @NotNull ConfigurateComponentSerializer configurate()
    Get an instance with default settings.

    Methods inherited from interface net.kyori.adventure.text.serializer.ComponentSerializer

    deseializeOrNull, deserialize, deserializeOr, deserializeOrNull, serialize, serializeOr, serializeOrNull

  • Method Details

    • configurate

      @NotNull static @NotNull ConfigurateComponentSerializer configurate()
      Get an instance with default settings.
      Returns:
      the shared default instance
      Since:
      4.0.0

    • builder

      @NotNull static @NotNull ConfigurateComponentSerializer.Builder builder()
      Create a new builder for a customized Configurate serializer.
      Returns:
      a new builder
      Since:
      4.0.0

    • addSerializersTo

      @NotNull @NotNull ninja.leaping.configurate.objectmapping.serialize.TypeSerializerCollection addSerializersTo​(@NotNull @NotNull ninja.leaping.configurate.objectmapping.serialize.TypeSerializerCollection collection)
      Populate an existing serializer collection with Adventure serializers.
      Parameters:
      collection - collection to populate
      Returns:
      input collection
      Since:
      4.0.0