Package jjparse.description

Class Literal

java.lang.Object

jjparse.description.Description

jjparse.description.Literal

public final class Literal
extends Description

A Description for Parsing.Parsers that expect a String literal.

Author:

Björn Lötters

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
final String	literal	The expected String literal.

Constructor Summary

Constructors

Constructor	Description
Literal(String literal)	Construct a new Literal 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

literal

public final String literal

The expected String literal.

Constructor Details

Literal

public Literal(String literal)

Construct a new Literal Description.

Parameters:

literal - The expected String literal.

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.