Package net.kyori.adventure.text

Interface TextReplacementConfig.Builder

All Superinterfaces:

Buildable.Builder<TextReplacementConfig>

Enclosing interface:

TextReplacementConfig

public static interface TextReplacementConfig.Builder
extends Buildable.Builder<TextReplacementConfig>

A builder for replacement configurations.

Since:

4.2.0

Method Summary

Modifier and Type	Method	Description
@NonNull TextReplacementConfig.Builder	condition(@NonNull IntFunction2<PatternReplacementResult> condition)	Set the function to determine how an individual match should be processed.
default @NonNull TextReplacementConfig.Builder	match(@NonNull @Regex String pattern)	Compile the provided input as a Pattern and match against it.
@NonNull TextReplacementConfig.Builder	match(@NonNull Pattern pattern)	Match the provided Pattern.
default TextReplacementConfig.Builder	matchLiteral(String literal)	Match against the literal string provided.
default @NonNull TextReplacementConfig.Builder	once()	Only replace the first occurrence of the matched pattern.
default @NonNull TextReplacementConfig.Builder	replacement(@NonNull String replacement)	Supply a literal replacement for the matched pattern.
@NonNull TextReplacementConfig.Builder	replacement(@NonNull BiFunction<MatchResult,TextComponent.Builder,@Nullable ComponentLike> replacement)	Supply a function that provides replacements for each match, with access to group information.
default @NonNull TextReplacementConfig.Builder	replacement(@NonNull Function<TextComponent.Builder,@Nullable ComponentLike> replacement)	Supply a function that provides replacements for each match.
default @NonNull TextReplacementConfig.Builder	replacement(@Nullable ComponentLike replacement)	Supply a literal replacement for the matched pattern.
default @NonNull TextReplacementConfig.Builder	times(int times)	Only replace the first times matches of the pattern.

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

build

Method Details

matchLiteral

default TextReplacementConfig.Builder matchLiteral(String literal)

Match against the literal string provided.

This will NOT be parsed as a regular expression.

Parameters:

literal - the literal string to match

Returns:

this builder

Since:

4.2.0

match

default @NonNull TextReplacementConfig.Builder match(@NonNull @Regex String pattern)

Compile the provided input as a Pattern and match against it.

Parameters:

pattern - the regex pattern to match

Returns:

this builder

Since:

4.2.0

match

@NonNull TextReplacementConfig.Builder match(@NonNull Pattern pattern)

Match the provided Pattern.

Parameters:

pattern - pattern to find in any searched components

Returns:

this builder

Since:

4.2.0

once

default @NonNull TextReplacementConfig.Builder once()

Only replace the first occurrence of the matched pattern.

Returns:

this builder

Since:

4.2.0

times

default @NonNull TextReplacementConfig.Builder times(int times)

Only replace the first times matches of the pattern.

Parameters:

times - maximum amount of matches to process

Returns:

this builder

Since:

4.2.0

condition

@NonNull TextReplacementConfig.Builder condition(@NonNull IntFunction2<PatternReplacementResult> condition)

Set the function to determine how an individual match should be processed.

Parameters:

condition - a function of (index, replaced) used to determine if matches should be replaced, where "replaced" is the number of successful replacements.

Returns:

this builder

Since:

4.2.0

replacement

default @NonNull TextReplacementConfig.Builder replacement(@NonNull String replacement)

Supply a literal replacement for the matched pattern.

Parameters:

replacement - the replacement

Returns:

this builder

Since:

4.2.0

replacement

default @NonNull TextReplacementConfig.Builder replacement(@Nullable ComponentLike replacement)

Supply a literal replacement for the matched pattern.

Parameters:

replacement - the replacement

Returns:

this builder

Since:

4.2.0

replacement

default @NonNull TextReplacementConfig.Builder replacement(@NonNull Function<TextComponent.Builder,@Nullable ComponentLike> replacement)

Supply a function that provides replacements for each match.

Parameters:

replacement - the replacement function

Returns:

this builder

Since:

4.2.0

replacement

@NonNull TextReplacementConfig.Builder replacement(@NonNull BiFunction<MatchResult,TextComponent.Builder,@Nullable ComponentLike> replacement)

Supply a function that provides replacements for each match, with access to group information.

Parameters:

replacement - the replacement function, taking a match result and a text component pre-populated with

Returns:

this builder

Since:

4.2.0