Interface RegexPattern

All Known Subinterfaces:

RegexPattern.CharacterProperty, RegexPattern.CharacterSet, RegexPattern.Group, RegexPattern.Lookaround

All Known Implementing Classes:

RegexPattern.Alternation, RegexPattern.Anchor, RegexPattern.CharacterProperty.Negated, RegexPattern.CharacterSet.AnyOf, RegexPattern.CharacterSet.NoneOf, RegexPattern.Group.Capturing, RegexPattern.Group.Named, RegexPattern.Group.NonCapturing, RegexPattern.Literal, RegexPattern.Lookaround.Lookahead, RegexPattern.Lookaround.Lookbehind, RegexPattern.Lookaround.NegativeLookahead, RegexPattern.Lookaround.NegativeLookbehind, RegexPattern.PosixCharClass, RegexPattern.PredefinedCharClass, RegexPattern.Quantified, RegexPattern.Sequence, RegexPattern.UnicodeProperty

public sealed interface RegexPattern
permits RegexPattern.Alternation, RegexPattern.Sequence, RegexPattern.Quantified, RegexPattern.Group, RegexPattern.Literal, RegexPattern.PredefinedCharClass, RegexPattern.CharacterProperty, RegexPattern.CharacterProperty.Negated, RegexPattern.CharacterSet, RegexPattern.Anchor, RegexPattern.Lookaround

Defines the Abstract Syntax Tree (AST) for a regular expression.

This AST is used to represent parsed regular expressions, as a basis to enable static analysis of regexes.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	RegexPattern.Alternation	Represents a choice between multiple alternative regex patterns.
static enum	RegexPattern.Anchor	Represents an anchor, which matches a position like start or end of a line.
static final record	RegexPattern.AtLeast	Represents a quantifier with a minimum bound, like {min,}, *, or +.
static final record	RegexPattern.AtMost	Represents a quantifier with a maximum bound and a minimum of 0, like {0,max} or ?.
static interface	RegexPattern.CharacterProperty	Represents a character property, like \p{Lower} or \P{Lower}.
static interface	RegexPattern.CharacterSet	Represents a custom character class, like [a-z] or [^0-9].
static final record	RegexPattern.CharRange	Represents a range of characters within a character class, e.g., 'a-z'.
static interface	RegexPattern.CharSetElement	Base interface for elements within a RegexPattern.CharacterSet.
static interface	RegexPattern.Group	Represents a grouping construct in a regex.
static final record	RegexPattern.Limited	Represents a quantifier with both minimum and maximum bounds, like {n} or {min,max}.
static final record	RegexPattern.Literal	Represents a literal string to be matched.
static final record	RegexPattern.LiteralChar	Represents a single literal character within a character class.
static interface	RegexPattern.Lookaround	Represents a lookaround assertion: (?=...), (?!...), (?<=...), (?<!...).
static enum	RegexPattern.PosixCharClass	Represents a POSIX character class inside a CharacterSet: e.g.
static enum	RegexPattern.PredefinedCharClass	Represents a predefined character class like \d or \w.
static final record	RegexPattern.Quantified	Represents a regex pattern that is modified by a quantifier.
static interface	RegexPattern.Quantifier	Base interface for all quantifier types.
static final record	RegexPattern.Sequence	Represents a sequence of regex patterns that must match consecutively.
static final record	RegexPattern.UnicodeProperty	Represents a Unicode property class: e.g.

Method Summary

Modifier and Type	Method	Description
static RegexPattern.Alternation	alternation(RegexPattern... alternatives)	Returns an RegexPattern.Alternation of the given alternatives.
static RegexPattern.CharacterSet.AnyOf	anyOf(RegexPattern.CharSetElement... elements)	Returns a RegexPattern.CharacterSet of the given elements.
static RegexPattern.CharacterSet.AnyOf	anyOf(Collection<? extends RegexPattern.CharSetElement> elements)	Returns a RegexPattern.CharacterSet of the given elements.
static Collector<RegexPattern, ?, RegexPattern>	asAlternation()	A collector that collects the input RegexPattern as an alternation.
default RegexPattern	followedBy(RegexPattern suffix)	Returns a pattern that matches this only if it is followed by suffix.
static Collector<RegexPattern, ?, RegexPattern>	inSequence()	A collector that collects the input RegexPattern as a sequence.
static RegexPattern.CharacterSet.NoneOf	noneOf(RegexPattern.CharSetElement... elements)	Returns a negated RegexPattern.CharacterSet of the given elements.
static RegexPattern.CharacterSet.NoneOf	noneOf(Collection<? extends RegexPattern.CharSetElement> elements)	Returns a negated RegexPattern.CharacterSet of the given elements.
default RegexPattern	notFollowedBy(RegexPattern suffix)	Returns a pattern that matches this only if it is NOT followed by suffix.
default RegexPattern	notPrecededBy(RegexPattern prefix)	Returns a pattern that matches this only if it is NOT preceded by prefix.
static RegexPattern	parse(String regex)	Parses the given regular expression string and returns its RegexPattern representation.
default RegexPattern	precededBy(RegexPattern prefix)	Returns a pattern that matches this only if it is preceded by prefix.
static RegexPattern.Sequence	sequence(RegexPattern... elements)	Returns a RegexPattern.Sequence of the given elements.

Method Details

sequence

@SafeVarargs
static RegexPattern.Sequence sequence(RegexPattern... elements)

Returns a RegexPattern.Sequence of the given elements.

inSequence

static Collector<RegexPattern, ?, RegexPattern> inSequence()

A collector that collects the input RegexPattern as a sequence. Nested sequences are flattened and adjacent literals are concatenated as a single literal.

alternation

@SafeVarargs
static RegexPattern.Alternation alternation(RegexPattern... alternatives)

Returns an RegexPattern.Alternation of the given alternatives.

asAlternation

static Collector<RegexPattern, ?, RegexPattern> asAlternation()

A collector that collects the input RegexPattern as an alternation.

anyOf

@SafeVarargs
static RegexPattern.CharacterSet.AnyOf anyOf(RegexPattern.CharSetElement... elements)

Returns a RegexPattern.CharacterSet of the given elements.

anyOf

static RegexPattern.CharacterSet.AnyOf anyOf(Collection<? extends RegexPattern.CharSetElement> elements)

Returns a RegexPattern.CharacterSet of the given elements.

noneOf

@SafeVarargs
static RegexPattern.CharacterSet.NoneOf noneOf(RegexPattern.CharSetElement... elements)

Returns a negated RegexPattern.CharacterSet of the given elements.

noneOf

static RegexPattern.CharacterSet.NoneOf noneOf(Collection<? extends RegexPattern.CharSetElement> elements)

Returns a negated RegexPattern.CharacterSet of the given elements.

precededBy

default RegexPattern precededBy(RegexPattern prefix)

Returns a pattern that matches this only if it is preceded by prefix. Equivalent to (?<=prefix)this.

followedBy

default RegexPattern followedBy(RegexPattern suffix)

Returns a pattern that matches this only if it is followed by suffix. Equivalent to this(?=suffix).

notPrecededBy

default RegexPattern notPrecededBy(RegexPattern prefix)

Returns a pattern that matches this only if it is NOT preceded by prefix. Equivalent to (?<!prefix)this.

notFollowedBy

default RegexPattern notFollowedBy(RegexPattern suffix)

Returns a pattern that matches this only if it is NOT followed by suffix. Equivalent to this(?!suffix).

parse

static RegexPattern parse(String regex)

Parses the given regular expression string and returns its RegexPattern representation.

Throws:

Parser.ParseException - if the regex pattern is malformed

IllegalArgumentException - if the regex pattern is invalid