com.github.fge.grappa.run

Class ParsingResult<V>

java.lang.Object

com.github.fge.grappa.run.ParsingResult<V>

public class ParsingResult<V>
extends Object

A simple container encapsulating the result of a parsing run.

Constructor Summary

Constructors

Constructor and Description
ParsingResult(boolean matched, ValueStack<V> valueStack, InputBuffer inputBuffer) Creates a new ParsingResult.

Method Summary

Methods

Modifier and Type	Method and Description
InputBuffer	getInputBuffer() Get the input buffer used by the parsing run
V	getTopStackValue() Gets the value at the top of the stack, if any
ValueStack<V>	getValueStack() Get the value stack
boolean	isSuccess() Return true if this parse result is a match

Methods inherited from class java.lang.Object

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

Constructor Detail

ParsingResult

public ParsingResult(boolean matched,
             @Nonnull
             ValueStack<V> valueStack,
             @Nonnull
             InputBuffer inputBuffer)

Creates a new ParsingResult.

Parameters:

matched - true if the rule matched the input

valueStack - the value stack of the parsing run

inputBuffer - the input buffer

Method Detail

isSuccess

public boolean isSuccess()

Return true if this parse result is a match

Returns:

see description

getTopStackValue

@Nonnull
public V getTopStackValue()

Gets the value at the top of the stack, if any

Returns:

the value at the top of the stack

Throws:

IllegalArgumentException - stack is empty

See Also:

ValueStack.peek()

getValueStack

@Nonnull
public ValueStack<V> getValueStack()

Get the value stack

Returns:

the value stack used during the parsing run

getInputBuffer

@Nonnull
public InputBuffer getInputBuffer()

Get the input buffer used by the parsing run

Returns:

see description