org.enginehub.piston.converter

Class ConversionResult<T>

java.lang.Object

org.enginehub.piston.converter.ConversionResult<T>

Direct Known Subclasses:

FailedConversion, SuccessfulConversion

public abstract class ConversionResult<T>
extends java.lang.Object

Represents the result of Converter.convert(String, InjectedValueAccess).

This either wraps the result, or contains errors explaining why it didn't match.

Method Summary

Modifier and Type	Method and Description
abstract <U> ConversionResult<U>	failureAsAny() If this result is a failure, recast as a different result type.
abstract java.util.Collection<T>	get() Get the result, or throw an exception with all collected errors.
abstract boolean	isSuccessful()
abstract <U> ConversionResult<U>	map(java.util.function.Function<? super java.util.Collection<T>,? extends java.util.Collection<U>> mapper) If successful, map the result using the given mapper.
<U> ConversionResult<U>	mapSingle(java.util.function.Function<? super T,? extends U> mapper)
java.util.Collection<T>	orElse(java.util.Collection<T> other)
abstract ConversionResult<T>	orElse(ConversionResult<T> result) Pick the successful result, or merge the errors of the two unsuccessful results.

Methods inherited from class java.lang.Object

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

Method Detail

isSuccessful

public abstract boolean isSuccessful()

failureAsAny

public abstract <U> ConversionResult<U> failureAsAny()

If this result is a failure, recast as a different result type.

This is useful for result collectors, where the result is a different type than the inputs.

orElse

public abstract ConversionResult<T> orElse(ConversionResult<T> result)

Pick the successful result, or merge the errors of the two unsuccessful results.

map

public abstract <U> ConversionResult<U> map(java.util.function.Function<? super java.util.Collection<T>,? extends java.util.Collection<U>> mapper)

If successful, map the result using the given mapper. Otherwise, return failureAsAny().

If mapper returns null, this becomes a failure, with a NullPointerException as the reason.

If mapper throws, this becomes a failure, with the exception as the reason.

Type Parameters:

U - the new type

Parameters:

mapper - the function to call if successful

Returns:

the new result

mapSingle

public final <U> ConversionResult<U> mapSingle(java.util.function.Function<? super T,? extends U> mapper)

orElse

public final java.util.Collection<T> orElse(java.util.Collection<T> other)

get

public abstract java.util.Collection<T> get()

Get the result, or throw an exception with all collected errors.