Package jjparse.description

Class Choice

java.lang.Object

jjparse.description.Description

jjparse.description.Choice

public final class Choice
extends Description

A Description for Parsing.Parsers that expect a Parsing.choice(jjparse.Parsing.Parser<? extends T>...).

Author:

Björn Lötters

See Also:

• Description
• Parsing.choice(jjparse.Parsing.Parser<? extends T>...)
• Parsing.Parser.description()

Field Summary

Fields

Modifier and Type	Field	Description
final List<Description>	alternatives	The List of alternative Descriptions.

Constructor Summary

Constructors

Constructor	Description
Choice(List<Description> alternatives)	Constructs a new Choice 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

alternatives

public final List<Description> alternatives

The List of alternative Descriptions.

Constructor Details

Choice

public Choice(List<Description> alternatives)

Constructs a new Choice Description.

Parameters:

alternatives - The list of alternative Descriptions.

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.