io.parsingdata.metal.token

Class Until

java.lang.Object

io.parsingdata.metal.token.Token

io.parsingdata.metal.token.Until

public class Until
extends Token

A Token that specifies a value to parse in the input until another token is parsed.

An Until consists of an initialSize, a stepSize and a maxSize (all ValueExpressions) and a terminator(a Token). First initialSize, stepSize, and maxSize are evaluated. Using this token's name, a value of length initialSize is added to the ParseState and an attempt is made to parse the terminator. If it succeeds, the resulting parseState is returned. Otherwise, stepSize is added to the initialSize and if the resulting value is below maxSize, a value with the resulting size is added to the original ParseState and a new attempt to parse the terminator is made. Parsing fails if no combination of any size is found where the terminator parses successfully.

If the ValueExpressions evaluate to lists, they are treated as sets of values to attempt. If stepSize is negative, maxSize must be smaller than initialSize. Parsing fails if stepSize is zero.

See Also:

ValueExpression

Field Summary

Fields

Modifier and Type	Field and Description
static ValueExpression	DEFAULT_INITIAL
static ValueExpression	DEFAULT_MAX
static ValueExpression	DEFAULT_STEP
ValueExpression	initialSize
ValueExpression	maxSize
ValueExpression	stepSize
Token	terminator

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

EMPTY_NAME, encoding, name, NO_NAME, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
Until(String name, ValueExpression initialSize, ValueExpression stepSize, ValueExpression maxSize, Token terminator, 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

DEFAULT_INITIAL

public static final ValueExpression DEFAULT_INITIAL

DEFAULT_STEP

public static final ValueExpression DEFAULT_STEP

DEFAULT_MAX

public static final ValueExpression DEFAULT_MAX

initialSize

public final ValueExpression initialSize

stepSize

public final ValueExpression stepSize

maxSize

public final ValueExpression maxSize

terminator

public final Token terminator

Constructor Detail

Until

public Until(String name,
             ValueExpression initialSize,
             ValueExpression stepSize,
             ValueExpression maxSize,
             Token terminator,
             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