io.parsingdata.metal.token

Class Sub

java.lang.Object

io.parsingdata.metal.token.Token

io.parsingdata.metal.token.Sub

public class Sub
extends Token

A Token that specifies a token to be parsed at a specific location in the input.

A Sub consists of a token (a Token) and an address (a ValueExpression). First address is evaluated. Then each resulting value is used as a location in the input to parse token at. Sub succeeds if all parses of token at all locations succeed. Sub fails if address evaluates to a list of locations that is either empty or contains an invalid value.

See Also:

ValueExpression

Field Summary

Fields

Modifier and Type	Field and Description
ValueExpression	address
Token	token

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

EMPTY_NAME, encoding, name, NO_NAME, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
Sub(String name, Token token, ValueExpression address, Encoding encoding)

Method Summary

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

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

getCanonical, makeNameFragment, parse

Methods inherited from class java.lang.Object

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

Field Detail

token

public final Token token

address

public final ValueExpression address

Constructor Detail

Sub

public Sub(String name,
           Token token,
           ValueExpression address,
           Encoding encoding)

Method Detail

parseImpl

protected Optional<ParseState> parseImpl(Environment environment)

Specified by:

parseImpl in class Token

isLocal

public boolean isLocal()

Overrides:

isLocal 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