Package net.kyori.adventure.text

Interface TextReplacementConfig

All Superinterfaces:

Buildable<TextReplacementConfig,TextReplacementConfig.Builder>, net.kyori.examination.Examinable

public interface TextReplacementConfig
extends Buildable<TextReplacementConfig,TextReplacementConfig.Builder>, net.kyori.examination.Examinable

A configuration for how text can be replaced in a component.

The exact structure for a replacement specification is an implementation detail and therefore not exposed. Custom implementations of TextReplacementConfig are not supported.

Since:

4.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TextReplacementConfig.Builder	A builder for replacement configurations.
static interface	TextReplacementConfig.Condition	A function determining whether a certain match should be replaced.

Method Summary

Modifier and Type	Method	Description
static @NotNull TextReplacementConfig.Builder	builder()	Create a new builder.
@NotNull Pattern	matchPattern()	Get the pattern that will be searched for.

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

toBuilder

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

builder

@NotNull
static @NotNull TextReplacementConfig.Builder builder()

Create a new builder.

Returns:

a new builder

Since:

4.2.0

matchPattern

@NotNull
@NotNull Pattern matchPattern()

Get the pattern that will be searched for.

Returns:

the match pattern

Since:

4.2.0