Package jjparse

Class Parsing.Success<T>

java.lang.Object

Parsing<I>.jjparse.Parsing.Result<T>

jjparse.Parsing.Success<T>

Type Parameters:

T - The covariant type of the parsed value.

Enclosing class:

Parsing<I>

public final class Parsing.Success<T>
extends Parsing<I>.Result<T>

Represents a successful result of a parsing operation.

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

Author:

Björn Lötters

See Also:

• Parsing.Result
• Parsing.Failure

Field Summary

Fields

Modifier and Type	Field	Description
final T	value	The parsed value of this Parsing.Success.

Fields inherited from class jjparse.Parsing.Result

rest

Constructor Summary

Constructors

Constructor	Description
Success(T value, Input<? extends I> rest)	Constructs a new Parsing.Success.

Method Summary

Modifier and Type	Method	Description
<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.
Optional<T>	get()	Returns the value of this Parsing.Result, if it is present.
T	getOrFail()	Returns the value of this Parsing.Result or fails with an exception, if it is not present.
boolean	isFailure()	Checks whether this Parsing.Result is a Parsing.Failure.
boolean	isSuccess()	Checks whether this Parsing.Result is a Parsing.Success.
<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

value

public final T value

The parsed value of this Parsing.Success.

Constructor Details

Success

public Success(T value,
 Input<? extends I> rest)

Constructs a new Parsing.Success.

Parameters:

value - The parsed value.

rest - The rest of the Input.

Method Details

get

public Optional<T> get()

Description copied from class: Parsing.Result

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

Specified by:

get in class Parsing<I>.Result<T>

Returns:

The optional value of this Parsing.Result.

getOrFail

public T getOrFail()
            throws NoSuchElementException

Description copied from class: Parsing.Result

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

Specified by:

getOrFail in class Parsing<I>.Result<T>

Returns:

The value of this Parsing.Result.

Throws:

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

isFailure

public boolean isFailure()

Description copied from class: Parsing.Result

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

Specified by:

isFailure in class Parsing<I>.Result<T>

Returns:

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

isSuccess

public boolean isSuccess()

Description copied from class: Parsing.Result

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

Specified by:

isSuccess in class Parsing<I>.Result<T>

Returns:

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

map

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

Description copied from class: Parsing.Result

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

Specified by:

map in class Parsing<I>.Result<T>

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 <U> Parsing<I>.Result<U> flatMap(Function<T,Parsing<I>.Result<U>> function)

Description copied from class: Parsing.Result

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.

Specified by:

flatMap in class Parsing<I>.Result<T>

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.