Package jjparse.description

Class RegExp

java.lang.Object

jjparse.description.Description

jjparse.description.RegExp

public final class RegExp
extends Description

A Description for Parsing.Parsers that expect a Pattern.

Author:

Björn Lötters

See Also:

• Description
• StringParsing.regex(java.lang.String)
• Parsing.Parser.description()
• Pattern

Field Summary

Fields

Modifier and Type	Field	Description
final Pattern	pattern	The expected Pattern of this Description.

Constructor Summary

Constructors

Constructor	Description
RegExp(Pattern pattern)	Constructs a new RegExp Description.

Method Summary

Modifier and Type	Method	Description
Optional<String>	describe()	Produces a String that explains what a corresponding Parsing.Parser would expect according to this Description.

Methods inherited from class jjparse.description.Description

and, negate, normalize, or

Methods inherited from class java.lang.Object

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

Field Details

pattern

public final Pattern pattern

The expected Pattern of this Description.

Constructor Details

RegExp

public RegExp(Pattern pattern)

Constructs a new RegExp Description.

Parameters:

pattern - The expected Pattern of this Description.

Method Details

describe

public Optional<String> describe()

Description copied from class: Description

Produces a String that explains what a corresponding Parsing.Parser would expect according to this Description.

Specified by:

describe in class Description

Returns:

An Optional String where Optional.empty() is returned in case this Description is Empty.