Package org.incendo.cloud.parser

Class ArgumentParseResult<T>

java.lang.Object

org.incendo.cloud.parser.ArgumentParseResult<T>

Type Parameters:

T - Parser return type

@API(status=STABLE)
public abstract class ArgumentParseResult<T>
extends Object

Result of the parsing done by a ArgumentParser

Method Summary

Modifier and Type	Method	Description
final @NonNull CompletableFuture<ArgumentParseResult<T>>	asFuture()	Maps the result to a completable future.
abstract @NonNull Optional<Throwable>	failure()	Get the failure reason, if it exists
static <T> @NonNull ArgumentParseResult<T>	failure(@NonNull Throwable failure)	Indicate that the parsing failed
static <T> @NonNull CompletableFuture<@NonNull ArgumentParseResult<T>>	failureFuture(@NonNull Throwable failure)	Create a future completed with a failed parse result.
abstract <O> @NonNull ArgumentParseResult<O>	flatMapSuccess(@NonNull Function<T,ArgumentParseResult<O>> mapper)	Returns the result from applying mapper to the parsed value, or the same failure as this result.
abstract <O> @NonNull CompletableFuture<ArgumentParseResult<O>>	flatMapSuccessFuture(@NonNull Function<T,CompletableFuture<ArgumentParseResult<O>>> mapper)	Returns a future resulting from applying mapper to the parsed value, or a completed future with the same failure as this result.
abstract <O> @NonNull ArgumentParseResult<O>	mapSuccess(@NonNull Function<T,O> mapper)	Returns the result from applying mapper to the parsed value and wrapping in success(Object), or the same failure as this result.
abstract <O> @NonNull CompletableFuture<ArgumentParseResult<O>>	mapSuccessFuture(@NonNull Function<T,CompletableFuture<O>> mapper)	Returns a success future resulting from applying mapper to the parsed value and wrapping in success(Object), or a completed future with the same failure as this result.
abstract @NonNull Optional<T>	parsedValue()	Get the parsed value, if it exists
static <T> @NonNull ArgumentParseResult<T>	success(@NonNull T value)	Indicate that the parsing succeeded
static <T> @NonNull CompletableFuture<@NonNull ArgumentParseResult<T>>	successFuture(@NonNull T value)	Create a future completed with a successful parse result.

Methods inherited from class java.lang.Object

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

Method Details

failure

public static <T> @NonNull ArgumentParseResult<T> failure(@NonNull Throwable failure)

Indicate that the parsing failed

If the failure is a CompletionException then it will be unwrapped.

Type Parameters:

T - Parser return type

Parameters:

failure - Failure reason

Returns:

Failed parse result

failureFuture

@API(status=STABLE)
public static <T>
@NonNull CompletableFuture<@NonNull ArgumentParseResult<T>> failureFuture(@NonNull Throwable failure)

Create a future completed with a failed parse result.

Type Parameters:

T - parser value type

Parameters:

failure - failure reason

Returns:

completed future with failed result

success

public static <T> @NonNull ArgumentParseResult<T> success(@NonNull T value)

Indicate that the parsing succeeded

Type Parameters:

T - Parser return type

Parameters:

value - Value produced by the parser

Returns:

Succeeded parse result

successFuture

@API(status=STABLE)
public static <T>
@NonNull CompletableFuture<@NonNull ArgumentParseResult<T>> successFuture(@NonNull T value)

Create a future completed with a successful parse result.

Type Parameters:

T - parser value type

Parameters:

value - parsed value

Returns:

completed future with successful result

parsedValue

@API(status=STABLE)
public abstract @NonNull Optional<T> parsedValue()

Get the parsed value, if it exists

Returns:

Optional containing the parsed value

failure

@API(status=STABLE)
public abstract @NonNull Optional<Throwable> failure()

Get the failure reason, if it exists

Returns:

Optional containing the failure reason

asFuture

@API(status=STABLE)
public final @NonNull CompletableFuture<ArgumentParseResult<T>> asFuture()

Maps the result to a completable future.

Returns:

the future

flatMapSuccessFuture

public abstract <O>
@NonNull CompletableFuture<ArgumentParseResult<O>> flatMapSuccessFuture(@NonNull Function<T,CompletableFuture<ArgumentParseResult<O>>> mapper)

Returns a future resulting from applying mapper to the parsed value, or a completed future with the same failure as this result.

Type Parameters:

O - new result value type

Parameters:

mapper - mapper

Returns:

new result future

mapSuccessFuture

public abstract <O>
@NonNull CompletableFuture<ArgumentParseResult<O>> mapSuccessFuture(@NonNull Function<T,CompletableFuture<O>> mapper)

Returns a success future resulting from applying mapper to the parsed value and wrapping in success(Object), or a completed future with the same failure as this result.

Type Parameters:

O - new result value type

Parameters:

mapper - mapper

Returns:

new result future

flatMapSuccess

public abstract <O> @NonNull ArgumentParseResult<O> flatMapSuccess(@NonNull Function<T,ArgumentParseResult<O>> mapper)

Returns the result from applying mapper to the parsed value, or the same failure as this result.

Type Parameters:

O - new result value type

Parameters:

mapper - mapper

Returns:

new result

mapSuccess

public abstract <O> @NonNull ArgumentParseResult<O> mapSuccess(@NonNull Function<T,O> mapper)

Returns the result from applying mapper to the parsed value and wrapping in success(Object), or the same failure as this result.

Type Parameters:

O - new result value type

Parameters:

mapper - mapper

Returns:

new result