Package be.sddevelopment.commons.validation

Class Fallible<T>

java.lang.Object

be.sddevelopment.commons.validation.Fallible<T>

public class Fallible<T>
extends Object

Monad-style Wrapper class to be used for condition based execution flows. Intended for use in validation-style flows.

Usage examples

   
  List errors = Fallible.of("")
           .ensure(this::mayNotContainNaughtyWords, d -> b -> b.errorCode("NAUGHTY_ERROR"))
           .ensure(StringUtils::isNotBlank, d -> b -> b.errorCode("MUST_BE_FILLED_IN"))
           .ensure(StringUtils::isMixedCase, d -> b -> b.errorCode("MUST_BE_MIXED_CASE"))
           .failures();
   
 

Since:

1.0.0

Version:

1.0.0

Author:

Stijn Dejongh

Method Summary

Modifier and Type	Method	Description
Fallible<T>	ensure(Rule<T> rule)
Fallible<T>	ensure(Function<T,Boolean> assertion)	ensure.
Fallible<T>	ensure(Function<T,Boolean> assertion, Function<T,Function<Failure.FailureBuilder,Failure.FailureBuilder>> error)	ensure.
Fallible<T>	errorTemplate(ErrorTemplate<T> template)	errorTemplate.
List<Failure>	failures()	Get the Failure objects resulting from applying all required rules to the data object.
Fallible<T>	ifValid(Consumer<T> actionToTake)	Execute a Consumer that takes an object of type T, when all previous {#link ensure()} conditions are met.
boolean	isValid()	isValid.
static <S> Fallible<S>	of(S toValidate)	Create a Fallible for an Object of type S.
Fallible<T>	orElse(Consumer<T> actionToTake)

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <S> Fallible<S> of(S toValidate)

Create a Fallible for an Object of type S.

Type Parameters:

S - class of the data object, will be inferred at creation time.

Parameters:

toValidate - the data object to execute conditional operations on.

Returns:

a Fallible for a data object of class S.

ensure

public Fallible<T> ensure(Function<T,Boolean> assertion,
                          Function<T,Function<Failure.FailureBuilder,Failure.FailureBuilder>> error)

ensure.

Parameters:

assertion - a Function object.

error - a Function object.

Returns:

a Fallible object.

ensure

public Fallible<T> ensure(Rule<T> rule)

Parameters:

rule - to check

Returns:

a Fallible object.

ensure

public Fallible<T> ensure(Function<T,Boolean> assertion)

ensure.

Parameters:

assertion - a Function object.

Returns:

a Fallible object.

ifValid

public Fallible<T> ifValid(Consumer<T> actionToTake)

Execute a Consumer that takes an object of type T, when all previous {#link ensure()} conditions are met.

Parameters:

actionToTake - a Consumer object.

Returns:

a Fallible object.

orElse

public Fallible<T> orElse(Consumer<T> actionToTake)

isValid

public boolean isValid()

isValid.

Returns:

a boolean.

errorTemplate

public Fallible<T> errorTemplate(ErrorTemplate<T> template)

errorTemplate.

Parameters:

template - a ErrorTemplate object.

Returns:

a Fallible object.

failures

public List<Failure> failures()

Get the Failure objects resulting from applying all required rules to the data object.

Returns:

a List containing Failure objects.