com.aol.cyclops.control

Class Validator<T,R,E>

java.lang.Object

com.aol.cyclops.control.Validator<T,R,E>

Type Parameters:

T - Input type

R - Return type

E - Error type

public class Validator<T,R,E>
extends java.lang.Object

A Cumulative Validator, that processes all validation steps and accumulates all results & errors Supports Lazy Validation (natively via isValid and add(Validator) ) And Eager Validation via FunctionalJava

Constructor Summary

Constructors

Constructor and Description
Validator()

Method Summary

Modifier and Type	Method and Description
ValidationResults<R,E>	accumulate() Accumulate validation results.
ValidationResults<R,E>	accumulate(T input) Accumulate validation results
ValidationResults<R,E>	accumulateUntilFail(T input) Run the accumulation until first fail
Validator<T,R,E>	add(Validator<T,R,E> validator) Add another Validator instance to this validation
Validator<T,R,E>	add(Xor<E,R> validation) Add a FunctionalJava Validation to this CumulativeValidation
Validator<T,R,E>	isValid(java.util.function.Predicate<? super T> valid, E error, R result) Add another validation to this cumulative validator
static <T,R,E> Validator<T,R,E>	of(java.util.function.Predicate<? super T> valid, E error, R result) Static factory method Construct a CumulativeValidator that checks for the supplied condition returns the supplied error if it doesn't hold or the supplied result if it does.
static <T,R,E> Validator<T,R,E>	of(Xor<E,R> validation) Static factory method Construct a CumulativeValidator from the supplied FunctionalJava validation object

Methods inherited from class java.lang.Object

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

Constructor Detail

Validator

public Validator()

Method Detail

isValid

public Validator<T,R,E> isValid(java.util.function.Predicate<? super T> valid,
                                E error,
                                R result)

Add another validation to this cumulative validator

 
 CumulativeValidator<User,String,String> validator = CumulativeValidator.of((User user)->user.age>18, "too young", "age ok")
 	ValidationResults<String,String> results  = validator.isValid(user->user.email!=null, "user email null","email ok")
    											.accumulate(new User(10,"[email protected]"));
    
    	assertThat(results.getResults().size(),equalTo(2));
    	
 
 }

Parameters:

valid - Validation Predicate to check

error - Error to return if validation predicate fails

result - Result to return if validation predicate succeeds

Returns:

accumulate

public ValidationResults<R,E> accumulate()

Accumulate validation results. For Eager Validation Generally not suited for Lazy Validation. Null will be used as input to lazy validation steps. User user = new User(10,"[email protected]"); ValidationResults results = CumulativeValidator.of(emailOk(user)) .add(ageOk(user)) .accumulate(); System.out.println(results);

Returns:

Validation Results

accumulate

public ValidationResults<R,E> accumulate(T input)

Accumulate validation results

  
 ValidationResults<String,String> results  = CumulativeValidator.of((User user)->user.age>18, "too young", "age ok")
    											.isValid(user->user.email!=null, "user email null","email ok")
    											.accumulate(new User(10,"[email protected]"));
    
    	assertThat(results.getResults().size(),equalTo(2));
 
 
 

Parameters:

input - Value to perform validation checks with

Returns:

Validation Results

accumulateUntilFail

public ValidationResults<R,E> accumulateUntilFail(T input)

Run the accumulation until first fail

  
 ValidationResults<String,String> results  = CumulativeValidator.of((User user)->user.age>18, "too young", "age ok")
    											.add(Validator.of((User user)->user.email!=null, "user email null","email ok"))
    											.accumulateUntilFail(new User(10,"[email protected]"));
    
    	assertThat(results.getResults().size(),equalTo(1));
 
 
 

Parameters:

input - Value to perform validation checks with

Returns:

Validation Results

add

public Validator<T,R,E> add(Xor<E,R> validation)

Add a FunctionalJava Validation to this CumulativeValidation

  
 
  User user = new User(10,"[email protected]");
    	ValidationResults<String,String> results  = CumulativeValidator.of(emailOk(user))
    													.add(user.age>18 ? Validation.success("age ok") : Validation.fail("too young"))
    													.accumulate();
    
    	
 

Parameters:

validation - FunctionalJava Validation to add

Returns:

CumulativeValidator that includes the new validation (or set of validations)

add

public Validator<T,R,E> add(Validator<T,R,E> validator)

Add another Validator instance to this validation

  
 ValidationResults<String,String> results  = CumulativeValidator.of((User user)->user.age>18, "too young", "age ok")
    											.add(Validator.of((User user)->user.email!=null, "user email null","email ok"))
    											.accumulate(new User(10,"[email protected]"));
    
    	assertThat(results.getResults().size(),equalTo(2));
 
 
 
 

Parameters:

validation - Validator instance

Returns:

CumulativeValidator that includes the new validation (or set of validations)

of

public static <T,R,E> Validator<T,R,E> of(java.util.function.Predicate<? super T> valid,
                                          E error,
                                          R result)

Static factory method Construct a CumulativeValidator that checks for the supplied condition returns the supplied error if it doesn't hold or the supplied result if it does. Further validation steps may be added to the returned validator

  
 	ValidationResults<String,String> results  = CumulativeValidator.of((User user)->user.age>18, "too young", "age ok")
    											.isValid(user->user.email!=null, "user email null","email ok")
    											.accumulate(new User(10,"[email protected]"));
    
    	assertThat(results.getResults().size(),equalTo(2));
 
 

Parameters:

valid - Validation Predicate to check

error - Error to return if validation predicate fails

result - Result to return if validation predicate succeeds

Returns:

of

public static <T,R,E> Validator<T,R,E> of(Xor<E,R> validation)

Static factory method Construct a CumulativeValidator from the supplied FunctionalJava validation object

  
 
  User user = new User(10,"[email protected]");
    	ValidationResults<String,String> results  = CumulativeValidator.of(emailOk(user))
    													.add(ageOk(user))
    													.accumulate();
    
    	
 
 public Validation<String,String> emailOk(User u){
        if(u.email!=null)
           return Validation.success("email ok");
         return Validation.fail("no email");
     }
     public Validation<String,String> ageOk(User u){
        if(u.age>18)
            return Validation.success("age ok");
        return Validation.fail("too young");
     }
 
 

Parameters:

validation - FuncitonalJava validation

Returns: