Interface Validation<E,T>
- Type Parameters:
E- value type in the case of invalidT- value type in the case of valid
- All Superinterfaces:
Iterable<T>, Serializable, Value<T>
- All Known Implementing Classes:
Validation.Invalid, Validation.Valid
An implementation similar to scalaz's Validation control.
The Validation type is different from a Monad type, it is an applicative functor. Whereas a Monad will short circuit after the first error, the applicative functor will continue on, accumulating ALL errors. This is especially helpful in cases such as validation, where you want to know all the validation errors that have occurred, not just the first one.
Validation construction:
Valid:
Validation<String,Integer> valid = Validation.valid(5);
Invalid:
Validation<List<String>,Integer> invalid = Validation.invalid(List.of("error1","error2"));
Validation combination:
Validation<String,String> valid1 = Validation.valid("John");
Validation<String,Integer> valid2 = Validation.valid(5);
Validation<String,Option<String>> valid3 = Validation.valid(Option.of("123 Fake St."));
Function3<String,Integer,Option<String>,Person> f = ...;
Validation<List<String>,String> result = valid1.combine(valid2).ap((name,age) -> "Name: "+name+" Age: "+age);
Validation<List<String>,Person> result2 = valid1.combine(valid2).combine(valid3).ap(f);
Another form of combining validations:
Validation<List<String>,Person> result3 = Validation.combine(valid1, valid2, valid3).ap(f);
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classstatic final classstatic final classstatic final classstatic final classstatic final classstatic final classstatic final classAn invalid Validationstatic final classA valid Validation -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiondefault <U> Validation<Seq<E>, U> default <E2,T2> Validation <E2, T2> Whereas map only performs a mapping on a valid Validation, and mapError performs a mapping on an invalid Validation, bimap allows you to provide mapping actions for both, and will give you the result based on what type of Validation this is.static <E,T1, T2> Validation.Builder <E, T1, T2> combine(Validation<E, T1> validation1, Validation<E, T2> validation2) Combines twoValidations into aValidation.Builder.static <E,T1, T2, T3>
Validation.Builder3<E, T1, T2, T3> combine(Validation<E, T1> validation1, Validation<E, T2> validation2, Validation<E, T3> validation3) Combines threeValidations into aValidation.Builder3.static <E,T1, T2, T3, T4>
Validation.Builder4<E, T1, T2, T3, T4> combine(Validation<E, T1> validation1, Validation<E, T2> validation2, Validation<E, T3> validation3, Validation<E, T4> validation4) Combines fourValidations into aValidation.Builder4.static <E,T1, T2, T3, T4, T5>
Validation.Builder5<E, T1, T2, T3, T4, T5> combine(Validation<E, T1> validation1, Validation<E, T2> validation2, Validation<E, T3> validation3, Validation<E, T4> validation4, Validation<E, T5> validation5) Combines fiveValidations into aValidation.Builder5.static <E,T1, T2, T3, T4, T5, T6>
Validation.Builder6<E, T1, T2, T3, T4, T5, T6> combine(Validation<E, T1> validation1, Validation<E, T2> validation2, Validation<E, T3> validation3, Validation<E, T4> validation4, Validation<E, T5> validation5, Validation<E, T6> validation6) Combines sixValidations into aValidation.Builder6.static <E,T1, T2, T3, T4, T5, T6, T7>
Validation.Builder7<E, T1, T2, T3, T4, T5, T6, T7> combine(Validation<E, T1> validation1, Validation<E, T2> validation2, Validation<E, T3> validation3, Validation<E, T4> validation4, Validation<E, T5> validation5, Validation<E, T6> validation6, Validation<E, T7> validation7) Combines sevenValidations into aValidation.Builder7.static <E,T1, T2, T3, T4, T5, T6, T7, T8>
Validation.Builder8<E, T1, T2, T3, T4, T5, T6, T7, T8> combine(Validation<E, T1> validation1, Validation<E, T2> validation2, Validation<E, T3> validation3, Validation<E, T4> validation4, Validation<E, T5> validation5, Validation<E, T6> validation6, Validation<E, T7> validation7, Validation<E, T8> validation8) Combines eightValidations into aValidation.Builder8.default <U> Validation.Builder<E, T, U> combine(Validation<E, U> validation) Combines twoValidations to form aValidation.Builder, which can then be used to perform further combines, or apply a function to it in order to transform theValidation.Builderinto aValidation.booleanClarifies that values have a proper equals() method implemented.default Option<Validation<E, T>> default <U> Validation<E, U> flatMap(Function<? super T, ? extends Validation<E, ? extends U>> mapper) default <U> UTransforms thisValidationto a value of typeU.default voidPerforms the given action for the value contained inValid, or does nothing if this is anInvalid.static <E,T> Validation <E, T> fromEither(Either<E, T> either) Creates aValidationof anEither.static <T> Validation<Throwable, T> Creates aValidationof anTry.get()Gets the value of thisValidationif is aValidor throws if this is anInvalid.getError()Gets the error of this Validation if it is anInvalidor throws if this is aValid.default TgetOrElseGet(Function<? super E, ? extends T> other) Gets the value if it is a Valid or an value calculated from the error.inthashCode()Clarifies that values have a proper hashCode() method implemented.static <E,T> Validation <E, T> invalid(E error) Creates anValidation.Invalidthat contains the givenerror.default booleanisAsync()AValidation's value is computed synchronously.default booleanisEmpty()Checks, thisValueis empty, i.e.booleanCheck whether this is of typeInvaliddefault booleanisLazy()AValidation's value is computed eagerly.default booleanStates whether this is a single-valued type.booleanisValid()Check whether this is of typeValiditerator()Returns a richio.vavr.collection.Iterator.default <U> Validation<E, U> Maps the underlying value to a different component type.default <U> Validation<U, T> Applies a function f to the error of this Validation if this is an Invalid.static <E,T> Validation <E, T> narrow(Validation<? extends E, ? extends T> validation) Narrows a widenedValidation<? extends E, ? extends T>toValidation<E, T>by performing a type-safe cast.default Validation<E, T> orElse(Validation<? extends E, ? extends T> other) Returns thisValidationif it is valid, otherwise return the alternative.default Validation<E, T> orElse(Supplier<Validation<? extends E, ? extends T>> supplier) Returns thisValidationif it is valid, otherwise return the result of evaluating supplier.default Validation<E, T> Performs the givenactionon the first element if this is an eager implementation.static <E,T> Validation <Seq<E>, Seq<T>> sequence(Iterable<? extends Validation<? extends Seq<? extends E>, ? extends T>> values) Reduces manyValidationinstances into a singleValidationby transforming anIterable<Validation<? extends T>>into aValidation<Seq<T>>.default Validation<T, E> swap()Flip the valid/invalid values for this Validation.toEither()Converts this Validation to anEither.toString()Clarifies that values have a proper toString() method implemented.static <E,T, U> Validation <Seq<E>, Seq<U>> traverse(Iterable<? extends T> values, Function<? super T, ? extends Validation<? extends Seq<? extends E>, ? extends U>> mapper) Maps the values of an iterable to a sequence of mapped values into a singleValidationby transforming anIterable<? extends T>into aValidation<Seq<U>>.static <E,T> Validation <E, T> valid(T value) Creates aValidation.Validthat contains the givenvalue.Methods inherited from interface Value
collect, collect, contains, corresponds, eq, exists, forAll, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, out, out, spliterator, stderr, stdout, stringPrefix, toArray, toCharSeq, toCompletableFuture, toEither, toEither, toInvalid, toInvalid, toJavaArray, toJavaArray, toJavaArray, toJavaCollection, toJavaList, toJavaList, toJavaMap, toJavaMap, toJavaMap, toJavaOptional, toJavaParallelStream, toJavaSet, toJavaSet, toJavaStream, toLeft, toLeft, toLinkedMap, toLinkedMap, toLinkedSet, toList, toMap, toMap, toOption, toPriorityQueue, toPriorityQueue, toQueue, toRight, toRight, toSet, toSortedMap, toSortedMap, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toStream, toTree, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector
-
Field Details
-
serialVersionUID
static final long serialVersionUID- See Also:
-
-
Method Details
-
valid
Creates aValidation.Validthat contains the givenvalue.- Type Parameters:
E- type of the errorT- type of the givenvalue- Parameters:
value- A value- Returns:
Valid(value)
-
invalid
Creates anValidation.Invalidthat contains the givenerror.- Type Parameters:
E- type of the givenerrorT- type of the value- Parameters:
error- An error- Returns:
Invalid(error)- Throws:
NullPointerException- if error is null
-
fromEither
Creates aValidationof anEither.- Type Parameters:
E- error typeT- value type- Parameters:
either- AnEither- Returns:
- A
Valid(either.get())if either is a Right, otherwiseInvalid(either.getLeft()). - Throws:
NullPointerException- if either is null
-
fromTry
Creates aValidationof anTry.- Type Parameters:
T- type of the valid value- Parameters:
t- ATry- Returns:
- A
Valid(t.get())if t is a Success, otherwiseInvalid(t.getCause()). - Throws:
NullPointerException- iftis null
-
sequence
static <E,T> Validation<Seq<E>,Seq<T>> sequence(Iterable<? extends Validation<? extends Seq<? extends E>, ? extends T>> values) Reduces manyValidationinstances into a singleValidationby transforming anIterable<Validation<? extends T>>into aValidation<Seq<T>>.- Type Parameters:
E- value type in the case of invalidT- value type in the case of valid- Parameters:
values- An iterable of Validation instances.- Returns:
- A valid Validation of a sequence of values if all Validation instances are valid or an invalid Validation containing an accumulated List of errors.
- Throws:
NullPointerException- if values is null
-
traverse
static <E,T, Validation<Seq<E>,U> Seq<U>> traverse(Iterable<? extends T> values, Function<? super T, ? extends Validation<? extends Seq<? extends E>, ? extends U>> mapper) Maps the values of an iterable to a sequence of mapped values into a singleValidationby transforming anIterable<? extends T>into aValidation<Seq<U>>.- Type Parameters:
E- The mapped error value type.T- The type of the given values.U- The mapped valid value type.- Parameters:
values- AnIterableof values.mapper- A mapper of values to Validations- Returns:
- A
Validationof aSeqof results. - Throws:
NullPointerException- if values or f is null.
-
narrow
Narrows a widenedValidation<? extends E, ? extends T>toValidation<E, T>by performing a type-safe cast. This is eligible because immutable/read-only collections are covariant.- Type Parameters:
E- type of errorT- type of valid value- Parameters:
validation- AValidation.- Returns:
- the given
validationinstance as narrowed typeValidation<E, T>.
-
combine
static <E,T1, Validation.Builder<E,T2> T1, combineT2> (Validation<E, T1> validation1, Validation<E, T2> validation2) Combines twoValidations into aValidation.Builder.- Type Parameters:
E- type of errorT1- type of first valid valueT2- type of second valid value- Parameters:
validation1- first validationvalidation2- second validation- Returns:
- an instance of Builder<E,T1,T2>
- Throws:
NullPointerException- if validation1 or validation2 is null
-
combine
static <E,T1, Validation.Builder3<E,T2, T3> T1, combineT2, T3> (Validation<E, T1> validation1, Validation<E, T2> validation2, Validation<E, T3> validation3) Combines threeValidations into aValidation.Builder3.- Type Parameters:
E- type of errorT1- type of first valid valueT2- type of second valid valueT3- type of third valid value- Parameters:
validation1- first validationvalidation2- second validationvalidation3- third validation- Returns:
- an instance of Builder3<E,T1,T2,T3>
- Throws:
NullPointerException- if validation1, validation2 or validation3 is null
-
combine
static <E,T1, Validation.Builder4<E,T2, T3, T4> T1, combineT2, T3, T4> (Validation<E, T1> validation1, Validation<E, T2> validation2, Validation<E, T3> validation3, Validation<E, T4> validation4) Combines fourValidations into aValidation.Builder4.- Type Parameters:
E- type of errorT1- type of first valid valueT2- type of second valid valueT3- type of third valid valueT4- type of fourth valid value- Parameters:
validation1- first validationvalidation2- second validationvalidation3- third validationvalidation4- fourth validation- Returns:
- an instance of Builder3<E,T1,T2,T3,T4>
- Throws:
NullPointerException- if validation1, validation2, validation3 or validation4 is null
-
combine
static <E,T1, Validation.Builder5<E,T2, T3, T4, T5> T1, combineT2, T3, T4, T5> (Validation<E, T1> validation1, Validation<E, T2> validation2, Validation<E, T3> validation3, Validation<E, T4> validation4, Validation<E, T5> validation5) Combines fiveValidations into aValidation.Builder5.- Type Parameters:
E- type of errorT1- type of first valid valueT2- type of second valid valueT3- type of third valid valueT4- type of fourth valid valueT5- type of fifth valid value- Parameters:
validation1- first validationvalidation2- second validationvalidation3- third validationvalidation4- fourth validationvalidation5- fifth validation- Returns:
- an instance of Builder3<E,T1,T2,T3,T4,T5>
- Throws:
NullPointerException- if validation1, validation2, validation3, validation4 or validation5 is null
-
combine
static <E,T1, Validation.Builder6<E,T2, T3, T4, T5, T6> T1, combineT2, T3, T4, T5, T6> (Validation<E, T1> validation1, Validation<E, T2> validation2, Validation<E, T3> validation3, Validation<E, T4> validation4, Validation<E, T5> validation5, Validation<E, T6> validation6) Combines sixValidations into aValidation.Builder6.- Type Parameters:
E- type of errorT1- type of first valid valueT2- type of second valid valueT3- type of third valid valueT4- type of fourth valid valueT5- type of fifth valid valueT6- type of sixth valid value- Parameters:
validation1- first validationvalidation2- second validationvalidation3- third validationvalidation4- fourth validationvalidation5- fifth validationvalidation6- sixth validation- Returns:
- an instance of Builder3<E,T1,T2,T3,T4,T5,T6>
- Throws:
NullPointerException- if validation1, validation2, validation3, validation4, validation5 or validation6 is null
-
combine
static <E,T1, Validation.Builder7<E,T2, T3, T4, T5, T6, T7> T1, combineT2, T3, T4, T5, T6, T7> (Validation<E, T1> validation1, Validation<E, T2> validation2, Validation<E, T3> validation3, Validation<E, T4> validation4, Validation<E, T5> validation5, Validation<E, T6> validation6, Validation<E, T7> validation7) Combines sevenValidations into aValidation.Builder7.- Type Parameters:
E- type of errorT1- type of first valid valueT2- type of second valid valueT3- type of third valid valueT4- type of fourth valid valueT5- type of fifth valid valueT6- type of sixth valid valueT7- type of seventh valid value- Parameters:
validation1- first validationvalidation2- second validationvalidation3- third validationvalidation4- fourth validationvalidation5- fifth validationvalidation6- sixth validationvalidation7- seventh validation- Returns:
- an instance of Builder3<E,T1,T2,T3,T4,T5,T6,T7>
- Throws:
NullPointerException- if validation1, validation2, validation3, validation4, validation5, validation6 or validation7 is null
-
combine
static <E,T1, Validation.Builder8<E,T2, T3, T4, T5, T6, T7, T8> T1, combineT2, T3, T4, T5, T6, T7, T8> (Validation<E, T1> validation1, Validation<E, T2> validation2, Validation<E, T3> validation3, Validation<E, T4> validation4, Validation<E, T5> validation5, Validation<E, T6> validation6, Validation<E, T7> validation7, Validation<E, T8> validation8) Combines eightValidations into aValidation.Builder8.- Type Parameters:
E- type of errorT1- type of first valid valueT2- type of second valid valueT3- type of third valid valueT4- type of fourth valid valueT5- type of fifth valid valueT6- type of sixth valid valueT7- type of seventh valid valueT8- type of eighth valid value- Parameters:
validation1- first validationvalidation2- second validationvalidation3- third validationvalidation4- fourth validationvalidation5- fifth validationvalidation6- sixth validationvalidation7- seventh validationvalidation8- eighth validation- Returns:
- an instance of Builder3<E,T1,T2,T3,T4,T5,T6,T7,T8>
- Throws:
NullPointerException- if validation1, validation2, validation3, validation4, validation5, validation6, validation7 or validation8 is null
-
isValid
boolean isValid()Check whether this is of typeValid- Returns:
- true if is a Valid, false if is an Invalid
-
isInvalid
boolean isInvalid()Check whether this is of typeInvalid- Returns:
- true if is an Invalid, false if is a Valid
-
orElse
Returns thisValidationif it is valid, otherwise return the alternative.- Parameters:
other- An alternativeValidation- Returns:
- this
Validationif it is valid, otherwise return the alternative.
-
orElse
Returns thisValidationif it is valid, otherwise return the result of evaluating supplier.- Parameters:
supplier- An alternativeValidationsupplier- Returns:
- this
Validationif it is valid, otherwise return the result of evaluating supplier.
-
isEmpty
-
get
T get()Gets the value of thisValidationif is aValidor throws if this is anInvalid.- Specified by:
getin interfaceValue<E>- Returns:
- The value of this
Validation - Throws:
NoSuchElementException- if this is anInvalid
-
getOrElseGet
Gets the value if it is a Valid or an value calculated from the error.- Parameters:
other- a function which converts an error to an alternative value- Returns:
- the value, if the underlying Validation is a Valid, or else the alternative value
provided by
otherby applying the error.
-
getError
E getError()Gets the error of this Validation if it is anInvalidor throws if this is aValid.- Returns:
- The error, if present
- Throws:
RuntimeException- if this is aValid
-
toEither
-
equals
Description copied from interface:ValueClarifies that values have a proper equals() method implemented. -
hashCode
-
toString
-
forEach
Performs the given action for the value contained inValid, or does nothing if this is anInvalid. -
fold
default <U> U fold(Function<? super E, ? extends U> ifInvalid, Function<? super T, ? extends U> ifValid) Transforms thisValidationto a value of typeU.Example:
Validation<List<String>, String> valid = ...;<br> int i = valid.fold(List::length, String::length);- Type Parameters:
U- the fold result type- Parameters:
ifInvalid- an error mapperifValid- an mapper for a valid value- Returns:
ifValid.apply(get())if this is valid, otherwiseifInvalid.apply(getError()).- Throws:
NullPointerException- if one of the given mappersifInvalidorifValidis null
-
swap
Flip the valid/invalid values for this Validation. If this is a Valid<E,T>, returns Invalid<T,E>. Or if this is an Invalid<E,T>, return a Valid<T,E>.- Returns:
- a flipped instance of Validation
-
map
-
bimap
default <E2,T2> Validation<E2,T2> bimap(Function<? super E, ? extends E2> errorMapper, Function<? super T, ? extends T2> valueMapper) Whereas map only performs a mapping on a valid Validation, and mapError performs a mapping on an invalid Validation, bimap allows you to provide mapping actions for both, and will give you the result based on what type of Validation this is. Without this, you would have to do something like: validation.map(...).mapError(...);- Type Parameters:
E2- type of the mapping result if this is an invalidT2- type of the mapping result if this is a valid- Parameters:
errorMapper- the invalid mapping operationvalueMapper- the valid mapping operation- Returns:
- an instance of Validation<U,R>
- Throws:
NullPointerException- if invalidMapper or validMapper is null
-
mapError
Applies a function f to the error of this Validation if this is an Invalid. Otherwise does nothing if this is a Valid.- Type Parameters:
U- type of the error resulting from the mapping- Parameters:
f- a function that maps the error in this Invalid- Returns:
- an instance of Validation<U,T>
- Throws:
NullPointerException- if mapping operation f is null
-
ap
default <U> Validation<Seq<E>,U> ap(Validation<Seq<E>, ? extends Function<? super T, ? extends U>> validation) -
combine
Combines twoValidations to form aValidation.Builder, which can then be used to perform further combines, or apply a function to it in order to transform theValidation.Builderinto aValidation.- Type Parameters:
U- type of the value contained in validation- Parameters:
validation- the validation object to combine this with- Returns:
- an instance of Builder
-
filter
-
flatMap
default <U> Validation<E,U> flatMap(Function<? super T, ? extends Validation<E, ? extends U>> mapper) -
peek
Description copied from interface:ValuePerforms the givenactionon the first element if this is an eager implementation. Performs the givenactionon all elements (the first immediately, successive deferred), if this is a lazy implementation. -
isAsync
-
isLazy
-
isSingleValued
default boolean isSingleValued()Description copied from interface:ValueStates whether this is a single-valued type.- Specified by:
isSingleValuedin interfaceValue<E>- Returns:
trueif this is single-valued,falseotherwise.
-
iterator
-