Package org.petitparser.context

Class Failure

java.lang.Object

org.petitparser.context.Context

org.petitparser.context.Result

org.petitparser.context.Failure

public class Failure
extends Result

An immutable parse failure.

Field Summary

Fields inherited from class org.petitparser.context.Context

buffer, position

Constructor Summary

Constructors

Constructor	Description
Failure(String buffer, int position, String message)

Method Summary

Modifier and Type	Method	Description
<T> T	get()	Returns the result of this parse context.
String	getMessage()	Returns the message of this parse context, only set in case of failure.
boolean	isFailure()	Returns true if this result indicates a parse failure.
String	toString()

Methods inherited from class org.petitparser.context.Context

failure, failure, getBuffer, getPosition, success, success

Methods inherited from class java.lang.Object

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

Methods inherited from class org.petitparser.context.Result

isSuccess

Constructor Detail

Failure

public Failure(String buffer,
               int position,
               String message)

Method Detail

getMessage

public String getMessage()

Description copied from class: Result

Returns the message of this parse context, only set in case of failure.

Overrides:

getMessage in class Result

isFailure

public boolean isFailure()

Description copied from class: Result

Returns true if this result indicates a parse failure.

Overrides:

isFailure in class Result

get

public <T> T get()

Description copied from class: Result

Returns the result of this parse context.

Specified by:

get in class Result

Type Parameters:

T - The type of the parse result.

toString

public String toString()

Overrides:

toString in class Context