Module net.kyori.adventure.text.serializer.plain

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

Interface PlainTextComponentSerializer

All Superinterfaces:

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

public interface PlainTextComponentSerializer
extends ComponentSerializer<Component,TextComponent,String>

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 PlainTextComponentSerializer.Builder	builder()	Create a new builder.
default TextComponent	deserialize(String input)
static PlainTextComponentSerializer	plainText()	A component serializer for plain-based serialization and deserialization.
void	serialize(StringBuilder sb, Component component)	Serializes.
default String	serialize(Component component)
PlainTextComponentSerializer.Builder	toBuilder()	Creates a new builder from this serializer.

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

deserializeOr, deserializeOrNull, serializeOr, serializeOrNull

Method Details

plainText

static PlainTextComponentSerializer plainText()

A component serializer for plain-based serialization and deserialization.

Returns:

serializer instance

Since:

4.8.0

builder

static PlainTextComponentSerializer.Builder builder()

Create a new builder.

Returns:

a new plain serializer builder

Since:

4.8.0

deserialize

default TextComponent deserialize(String input)

Specified by:

deserialize in interface ComponentDecoder<String,TextComponent>

Specified by:

deserialize in interface ComponentSerializer<Component,TextComponent,String>

serialize

default String serialize(Component component)

Specified by:

serialize in interface ComponentEncoder<Component,String>

Specified by:

serialize in interface ComponentSerializer<Component,TextComponent,String>

serialize

void serialize(StringBuilder sb,
 Component component)

Serializes.

Parameters:

sb - the string builder

component - the component

Since:

4.8.0

toBuilder

PlainTextComponentSerializer.Builder toBuilder()

Creates a new builder from this serializer.

Returns:

the builder

Since:

4.8.0