Package net.kyori.adventure.text.serializer.plain

Interface PlainTextComponentSerializer

All Superinterfaces:

Buildable<PlainTextComponentSerializer,PlainTextComponentSerializer.Builder>, ComponentSerializer<Component,TextComponent,String>

public interface PlainTextComponentSerializer
extends ComponentSerializer<Component,TextComponent,String>, Buildable<PlainTextComponentSerializer,PlainTextComponentSerializer.Builder>

A plain-text component serializer.

Plain does not support more complex features such as, but not limited to, colours, decorations, ClickEvent, and HoverEvent.

Since:

4.8.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PlainTextComponentSerializer.Builder	A builder for the plain-text component serializer.
static interface	PlainTextComponentSerializer.Provider	A PlainTextComponentSerializer service provider.

Method Summary

Modifier and Type	Method	Description
static @NotNull PlainTextComponentSerializer.Builder	builder()	Create a new builder.
default @NotNull TextComponent	deserialize(@NotNull String input)
static @NotNull PlainTextComponentSerializer	plainText()	A component serializer for plain-based serialization and deserialization.
void	serialize(@NotNull StringBuilder sb, @NotNull Component component)	Serializes.
default @NotNull String	serialize(@NotNull Component component)

Methods inherited from interface net.kyori.adventure.util.Buildable

toBuilder

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

deseializeOrNull, deserializeOr, deserializeOrNull, serializeOr, serializeOrNull

Method Detail

plainText

@NotNull
static @NotNull PlainTextComponentSerializer plainText()

A component serializer for plain-based serialization and deserialization.

Returns:

serializer instance

Since:

4.8.0

builder

static @NotNull PlainTextComponentSerializer.Builder builder()

Create a new builder.

Returns:

a new plain serializer builder

Since:

4.8.0

deserialize

@NotNull
default @NotNull TextComponent deserialize(@NotNull
                                           @NotNull String input)

Specified by:

deserialize in interface ComponentSerializer<Component,TextComponent,String>

serialize

@NotNull
default @NotNull String serialize(@NotNull
                                  @NotNull Component component)

Specified by:

serialize in interface ComponentSerializer<Component,TextComponent,String>

serialize

void serialize(@NotNull
               @NotNull StringBuilder sb,
               @NotNull
               @NotNull Component component)

Serializes.

Parameters:

sb - the string builder

component - the component

Since:

4.8.0