Module org.pcre4j

Package org.pcre4j.option

Enum Class Pcre2SubstituteOption

java.lang.Object

java.lang.Enum<Pcre2SubstituteOption>

org.pcre4j.option.Pcre2SubstituteOption

All Implemented Interfaces:

Serializable, Comparable<Pcre2SubstituteOption>, Constable

public enum Pcre2SubstituteOption
extends Enum<Pcre2SubstituteOption>

Substitute options for Pcre2Code.substitute(java.lang.String, int, java.util.EnumSet<org.pcre4j.option.Pcre2SubstituteOption>, org.pcre4j.Pcre2MatchData, org.pcre4j.Pcre2MatchContext, java.lang.String)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXTENDED	Enable extended replacement processing
GLOBAL	Replace all occurrences throughout subject
LITERAL	Treat replacement as literal text
MATCHED	Use pre-existing match data for initial match
OVERFLOW_LENGTH	Calculate needed length on buffer overflow
REPLACEMENT_ONLY	Return only replacement string(s)
UNKNOWN_UNSET	Handle undefined groups as unset
UNSET_EMPTY	Insert empty string for unset groups

Method Summary

Modifier and Type	Method	Description
int	value()	Get the option value of the enum value.
static Optional<Pcre2SubstituteOption>	valueOf(int value)	Get the enum value by its option value.
static Pcre2SubstituteOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Pcre2SubstituteOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GLOBAL

public static final Pcre2SubstituteOption GLOBAL

Replace all occurrences throughout subject

EXTENDED

public static final Pcre2SubstituteOption EXTENDED

Enable extended replacement processing

UNSET_EMPTY

public static final Pcre2SubstituteOption UNSET_EMPTY

Insert empty string for unset groups

UNKNOWN_UNSET

public static final Pcre2SubstituteOption UNKNOWN_UNSET

Handle undefined groups as unset

OVERFLOW_LENGTH

public static final Pcre2SubstituteOption OVERFLOW_LENGTH

Calculate needed length on buffer overflow

LITERAL

public static final Pcre2SubstituteOption LITERAL

Treat replacement as literal text

MATCHED

public static final Pcre2SubstituteOption MATCHED

Use pre-existing match data for initial match

REPLACEMENT_ONLY

public static final Pcre2SubstituteOption REPLACEMENT_ONLY

Return only replacement string(s)

Method Details

values

public static Pcre2SubstituteOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Pcre2SubstituteOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

valueOf

public static Optional<Pcre2SubstituteOption> valueOf(int value)

Get the enum value by its option value.

Parameters:

value - the integer value of the option

Returns:

the flag

value

public int value()

Get the option value of the enum value.

Returns:

the integer value of the option