Package net.kyori.adventure.text.serializer.json

Interface JSONComponentSerializer

All Superinterfaces:

ComponentDecoder<String,Component>, ComponentEncoder<Component,String>, ComponentSerializer<Component,Component,String>

public interface JSONComponentSerializer
extends ComponentSerializer<Component,Component,String>

A JSON component serializer.

This serializer exposes a common superset of functionality across any number of JSON library implementations. For more specialized operations, users may need to refer to specific implementations.

Since:

4.14.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	JSONComponentSerializer.Builder	A builder for JSONComponentSerializer instances that delegates to the active serializer.
static interface	JSONComponentSerializer.Provider	A JSONComponentSerializer service provider.

Method Summary

Static Methods

Modifier and Type	Method	Description
static @NotNull JSONComponentSerializer.Builder	builder()	Get a builder to create a customized JSON serializer instance.
static @NotNull JSONComponentSerializer	json()	Gets a component serializer for JSON serialization and deserialization.

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

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

Method Details

json

@NotNull
static @NotNull JSONComponentSerializer json()

Gets a component serializer for JSON serialization and deserialization.

Returns:

a JSON component serializer

Since:

4.14.0

builder

static @NotNull JSONComponentSerializer.Builder builder()

Get a builder to create a customized JSON serializer instance.

Returns:

the new builder

Since:

4.14.0