dev.vankka.enhancedlegacytext

Class EnhancedComponentBuilder

java.lang.Object

dev.vankka.enhancedlegacytext.EnhancedComponentBuilder

public class EnhancedComponentBuilder
extends java.lang.Object

A helper class for creating enhanced legacy components. The replacements may be any of the following: - TextColor (or Color) - Component - ComponentBuilder - TextFormat - Style - Any other Objects will be converted to strings

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnhancedComponentBuilder(EnhancedLegacyText enhancedLegacyText, java.lang.String input)

Method Summary

Modifier and Type	Method and Description
net.kyori.adventure.text.Component	build() Creates a Component from the provided input and replacements.
@NotNull java.lang.String	getInput() Getter for the input text.
RecursiveReplacement	getRecursiveReplacement() Gets the recursive replacement policy.
@NotNull java.util.List<Pair<java.util.regex.Pattern,java.util.function.Function<java.util.regex.Matcher,java.lang.Object>>>	getReplacements() Getter for the replacements.
@NotNull EnhancedComponentBuilder	replace(@NotNull java.lang.String target, @NotNull java.util.function.Function<java.util.regex.Matcher,java.lang.Object> replacement) Adds a replacement to the component.
EnhancedComponentBuilder	replace(java.lang.String target, java.lang.Object replacement) Adds a replacement to the component.
EnhancedComponentBuilder	replace(java.lang.String target, java.util.function.Supplier<java.lang.Object> replacement) Adds a replacement to the component.
@NotNull EnhancedComponentBuilder	replaceAll(@NotNull java.util.regex.Pattern regex, @NotNull java.util.function.Function<java.util.regex.Matcher,java.lang.Object> replacement) Adds a replacement to the component.
EnhancedComponentBuilder	replaceAll(java.util.regex.Pattern regex, java.lang.Object replacement) Adds a replacement to the component.
EnhancedComponentBuilder	replaceAll(java.util.regex.Pattern regex, java.util.function.Supplier<java.lang.Object> replacement) Adds a replacement to the component.
@NotNull EnhancedComponentBuilder	replaceAll(@NotNull java.lang.String regex, @NotNull java.util.function.Function<java.util.regex.Matcher,java.lang.Object> replacement) Adds a replacement to the component.
EnhancedComponentBuilder	replaceAll(java.lang.String regex, java.lang.Object replacement) Adds a replacement to the component.
EnhancedComponentBuilder	replaceAll(java.lang.String regex, java.util.function.Supplier<java.lang.Object> replacement) Adds a replacement to the component.
EnhancedComponentBuilder	setRecursiveReplacement(@NotNull RecursiveReplacement replacement) Sets the recursive replacement policy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnhancedComponentBuilder

protected EnhancedComponentBuilder(EnhancedLegacyText enhancedLegacyText,
                                   java.lang.String input)

Method Detail

replace

public EnhancedComponentBuilder replace(java.lang.String target,
                                        java.lang.Object replacement)

Adds a replacement to the component.

Parameters:

target - the literal text to replace

replacement - the replacement (see EnhancedComponentBuilder for possible replacements)

Returns:

this builder instance - useful for chaining

replaceAll

public EnhancedComponentBuilder replaceAll(java.lang.String regex,
                                           java.lang.Object replacement)

Adds a replacement to the component.

Parameters:

regex - the regex pattern for the replacement

replacement - the replacement (see EnhancedComponentBuilder for possible replacements)

Returns:

this builder instance - useful for chaining

replaceAll

public EnhancedComponentBuilder replaceAll(java.util.regex.Pattern regex,
                                           java.lang.Object replacement)

Adds a replacement to the component.

Parameters:

regex - the regex pattern for the replacement

replacement - the replacement (see EnhancedComponentBuilder for possible replacements)

Returns:

this builder instance - useful for chaining

replace

public EnhancedComponentBuilder replace(java.lang.String target,
                                        java.util.function.Supplier<java.lang.Object> replacement)

Adds a replacement to the component.

Parameters:

target - the literal text to replace

replacement - the replacement (see EnhancedComponentBuilder for possible replacements)

Returns:

this builder instance - useful for chaining

replaceAll

public EnhancedComponentBuilder replaceAll(java.lang.String regex,
                                           java.util.function.Supplier<java.lang.Object> replacement)

Adds a replacement to the component.

Parameters:

regex - the regex pattern for the replacement

replacement - the replacement (see EnhancedComponentBuilder for possible replacements)

Returns:

this builder instance - useful for chaining

replaceAll

public EnhancedComponentBuilder replaceAll(java.util.regex.Pattern regex,
                                           java.util.function.Supplier<java.lang.Object> replacement)

Adds a replacement to the component.

Parameters:

regex - the regex pattern for the replacement

replacement - the replacement (see EnhancedComponentBuilder for possible replacements)

Returns:

this builder instance - useful for chaining

replace

@NotNull
public @NotNull EnhancedComponentBuilder replace(@NotNull
                                                          @NotNull java.lang.String target,
                                                          @NotNull
                                                          @NotNull java.util.function.Function<java.util.regex.Matcher,java.lang.Object> replacement)

Adds a replacement to the component.

Parameters:

target - the literal text to replace

replacement - the replacement (see EnhancedComponentBuilder for possible replacements)

Returns:

this builder instance - useful for chaining

replaceAll

@NotNull
public @NotNull EnhancedComponentBuilder replaceAll(@NotNull
                                                             @NotNull java.lang.String regex,
                                                             @NotNull
                                                             @NotNull java.util.function.Function<java.util.regex.Matcher,java.lang.Object> replacement)

Adds a replacement to the component.

Parameters:

regex - the regex pattern for the replacement

replacement - the replacement (see EnhancedComponentBuilder for possible replacements)

Returns:

this builder instance - useful for chaining

replaceAll

@NotNull
public @NotNull EnhancedComponentBuilder replaceAll(@NotNull
                                                             @NotNull java.util.regex.Pattern regex,
                                                             @NotNull
                                                             @NotNull java.util.function.Function<java.util.regex.Matcher,java.lang.Object> replacement)

Adds a replacement to the component.

Parameters:

regex - the regex pattern for the replacement

replacement - the replacement (see EnhancedComponentBuilder for possible replacements)

Returns:

this builder instance - useful for chaining

getInput

@NotNull
public @NotNull java.lang.String getInput()

Getter for the input text.

Returns:

the input text

getReplacements

@NotNull
public @NotNull java.util.List<Pair<java.util.regex.Pattern,java.util.function.Function<java.util.regex.Matcher,java.lang.Object>>> getReplacements()

Getter for the replacements.

Returns:

the replacements

setRecursiveReplacement

public EnhancedComponentBuilder setRecursiveReplacement(@NotNull
                                                        @NotNull RecursiveReplacement replacement)

Sets the recursive replacement policy. The default value is RecursiveReplacement.ONLY_FOLLOWING.

Parameters:

replacement - the recursive replacement policy

Returns:

this builder instance - useful for chaining

getRecursiveReplacement

public RecursiveReplacement getRecursiveReplacement()

Gets the recursive replacement policy.

Returns:

the recursive replacement policy

build

public net.kyori.adventure.text.Component build()

Creates a Component from the provided input and replacements.

Returns:

a new Component