Package net.kyori.adventure.text.serializer.ansi

Interface ANSIComponentSerializer

All Superinterfaces:

ComponentEncoder<Component,String>

public interface ANSIComponentSerializer
extends ComponentEncoder<Component,String>

A serializer which emits ANSI escape sequences.

Note that this serializer does NOT support deserialization.

Since:

4.14.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ANSIComponentSerializer.Builder	A builder for the ANSI component serializer.
static interface	ANSIComponentSerializer.Provider	A ANSIComponentSerializer service provider.

Method Summary

Static Methods

Modifier and Type	Method	Description
static @NotNull ANSIComponentSerializer	ansi()	Gets a component serializer for serialization to a string using ANSI escape codes.
static @NotNull ANSIComponentSerializer.Builder	builder()	Create a new builder.

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

serialize, serializeOr, serializeOrNull

Method Details

ansi

@NotNull
static @NotNull ANSIComponentSerializer ansi()

Gets a component serializer for serialization to a string using ANSI escape codes.

Note that this serializer does NOT support deserialization.

Returns:

a component serializer for serialization with ANSI escape sequences.

Since:

4.14.0

builder

static @NotNull ANSIComponentSerializer.Builder builder()

Create a new builder.

Returns:

a new ANSI serializer builder

Since:

4.14.0