Package net.kyori.adventure.text

Enum PatternReplacementResult

java.lang.Object

java.lang.Enum<PatternReplacementResult>

net.kyori.adventure.text.PatternReplacementResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PatternReplacementResult>

public enum PatternReplacementResult
extends java.lang.Enum<PatternReplacementResult>

A result for Component.replaceText(TextReplacementConfig) pattern-based replacements}.

Since:

4.0.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTINUE	Skip the current match, but continue searching for others.
REPLACE	Replace the current match.
STOP	Stop matching.

Method Summary

Modifier and Type	Method	Description
static PatternReplacementResult	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static PatternReplacementResult[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REPLACE

public static final PatternReplacementResult REPLACE

Replace the current match.

Since:

4.0.0

CONTINUE

public static final PatternReplacementResult CONTINUE

Skip the current match, but continue searching for others.

Since:

4.0.0

STOP

public static final PatternReplacementResult STOP

Stop matching.

Since:

4.0.0

Method Detail

values

public static PatternReplacementResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PatternReplacementResult c : PatternReplacementResult.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PatternReplacementResult valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null