io.parsingdata.metal.token

Class While

java.lang.Object

io.parsingdata.metal.token.Token

io.parsingdata.metal.token.While

public class While
extends Token

A Token that specifies a conditional repetition of a token.

A While consists of a token (a Token) and a predicate (an Expression). Each loop, predicate is evaluated. If it evaluates to true, token is parsed. If that succeeds, the loop is repeated. When predicate evaluates to false, the While terminates and succeeds. If parsing token fails, the While also fails.

See Also:

Expression

Field Summary

Fields

Modifier and Type	Field and Description
Expression	predicate
Token	token

Fields inherited from class io.parsingdata.metal.token.Token

EMPTY_NAME, encoding, name, NO_NAME, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
While(String name, Token token, Expression predicate, Encoding encoding)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	hashCode()
protected Optional<ParseState>	parseImpl(Environment environment)
String	toString()

Methods inherited from class io.parsingdata.metal.token.Token

getCanonical, isLocal, makeNameFragment, parse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

token

public final Token token

predicate

public final Expression predicate

Constructor Detail

While

public While(String name,
             Token token,
             Expression predicate,
             Encoding encoding)

Method Detail

parseImpl

protected Optional<ParseState> parseImpl(Environment environment)

Specified by:

parseImpl in class Token

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Token

hashCode

public int hashCode()

Overrides:

hashCode in class Token