io.parsingdata.metal.token

Class TokenRef

java.lang.Object

io.parsingdata.metal.token.Token

io.parsingdata.metal.token.TokenRef

public class TokenRef
extends Token

A Token that references a previously parsed token.

TokenRef consists of a referenceName (a String). In order to allow the construction of recursive tokens, this token can be used to reference an enclosing token and use it at the current location. An example for use of this token is to recursively define a linked list.

The referenced token is located in the current parse state by traversing it backwards until it is located. Parsing will fail if it is not found.

See Also:

NameRef, TokenRef

Field Summary

Fields

Modifier and Type	Field and Description
String	referenceName

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

encoding, name, NO_NAME, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
TokenRef(String name, String referenceName, Encoding encoding)

Method Summary

Modifier and Type	Method and Description
Token	getCanonical(Environment environment)
protected ParseResult	parseImpl(String scope, Environment environment, Encoding encoding)

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

isLocal, makeNameFragment, parse, parse

Methods inherited from class java.lang.Object

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

Field Detail

referenceName

public final String referenceName

Constructor Detail

TokenRef

public TokenRef(String name,
                String referenceName,
                Encoding encoding)

Method Detail

parseImpl

protected ParseResult parseImpl(String scope,
                                Environment environment,
                                Encoding encoding)
                         throws IOException

Specified by:

parseImpl in class Token

Throws:

IOException

getCanonical

public Token getCanonical(Environment environment)

Overrides:

getCanonical in class Token