Package jjparse

Class Parsing.Result<T>

java.lang.Object

jjparse.Parsing.Result<T>

Type Parameters:

T - The covariant type of the parsed value in case of a Parsing.Success.

Direct Known Subclasses:

Parsing.Failure, Parsing.Success

Enclosing class:

Parsing<I>

public abstract sealed class Parsing.Result<T>
extends Object
permits Parsing<I>.Success<T>, Parsing<I>.Failure<T>

Represents the result of a parsing operation.

A Parsing.Result can either be a Parsing.Success or a Parsing.Failure, whereas a failure is further divided into:

• Parsing.Error: A recoverable kind of Parsing.Failure that may trigger backtracking during parsing.
• Parsing.Abort: A fatal kind of Parsing.Failure that does not trigger backtracking and aborts parsing.

Note: This class is intended to be immutable and hence covariant in its type parameter.

Author:

Björn Lötters

See Also:

• Parsing.Success
• Parsing.Failure
• Input

Field Summary

Fields

Modifier and Type	Field	Description
final Input<I>	rest	The rest of the Input.

Constructor Summary

Constructors

Constructor	Description
Result(Input<? extends I> rest)	The base constructor for Parsing.Result.

Method Summary

Modifier and Type	Method	Description
abstract <U> Parsing<I>.Result<U>	flatMap(Function<T,Parsing<I>.Result<U>> function)	Maps the value of this Parsing.Result in case it is a Parsing.Success to another Parsing.Result using the provided Function and flattens the nested Parsing.Result.
abstract Optional<T>	get()	Returns the value of this Parsing.Result, if it is present.
abstract T	getOrFail()	Returns the value of this Parsing.Result or fails with an exception, if it is not present.
abstract boolean	isFailure()	Checks whether this Parsing.Result is a Parsing.Failure.
abstract boolean	isSuccess()	Checks whether this Parsing.Result is a Parsing.Success.
abstract <U> Parsing<I>.Result<U>	map(Function<T,U> function)	Maps the value of this Parsing.Result in case it is a Parsing.Success using the provided Function.

Methods inherited from class java.lang.Object

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

Field Details

rest

public final Input<I> rest

The rest of the Input.

Constructor Details

Result

public Result(Input<? extends I> rest)

The base constructor for Parsing.Result.

Parameters:

rest - The rest of the Input.

Method Details

get

public abstract Optional<T> get()

Returns the value of this Parsing.Result, if it is present.

Returns:

The optional value of this Parsing.Result.

getOrFail

public abstract T getOrFail()
                     throws NoSuchElementException

Returns the value of this Parsing.Result or fails with an exception, if it is not present.

Returns:

The value of this Parsing.Result.

Throws:

NoSuchElementException - If this Parsing.Result is not a Parsing.Success.

isFailure

public abstract boolean isFailure()

Checks whether this Parsing.Result is a Parsing.Failure.

Returns:

true if this Parsing.Result is a Parsing.Failure.

isSuccess

public abstract boolean isSuccess()

Checks whether this Parsing.Result is a Parsing.Success.

Returns:

true if this Parsing.Result is a Parsing.Success.

map

public abstract <U> Parsing<I>.Result<U> map(Function<T,U> function)

Maps the value of this Parsing.Result in case it is a Parsing.Success using the provided Function.

Type Parameters:

U - The type of the mapped value.

Parameters:

function - The Function used to map the value.

Returns:

A Parsing.Result which contains the mapped value.

flatMap

public abstract <U> Parsing<I>.Result<U> flatMap(Function<T,Parsing<I>.Result<U>> function)

Maps the value of this Parsing.Result in case it is a Parsing.Success to another Parsing.Result using the provided Function and flattens the nested Parsing.Result.

Type Parameters:

U - The type of the returned Parsing.Result.

Parameters:

function - The Function used to map the value.

Returns:

The Parsing.Result of the mapped value.