Package net.kyori.adventure.text

Interface TextReplacementConfig.Builder

    • Method Detail

      • matchLiteral

        @Contract("_ -> this")
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

        @Contract("_ -> this")
default @NonNull TextReplacementConfig.Builder match​(@NonNull 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

        @Contract("_ -> this")
@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

        @Contract("-> this")
default @NonNull TextReplacementConfig.Builder once()
        Only replace the first occurrence of the matched pattern.
        Returns:
        this builder
        Since:
        4.2.0

      • times

        @Contract("_ -> this")
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

        @Contract("_ -> this")
@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

        @Contract("_ -> this")
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

        @Contract("_ -> this")
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

        @Contract("_ -> this")
@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