org.srplib.validation
Class ValidationErrors

java.lang.Object
  extended by org.srplib.validation.ValidationErrors

public class ValidationErrors
extends Object

Validation error collector object.

Is used by binding code to collect validation errors.

Normally ValidationErrors is created by auto-binding code, but it can be created implicitly by throwing validation exception:

  throw new ValidationException("error message");
  throw new ValidationException(Validators.newError("Error message", formField));
 

or explicitly:

  ValidationErrors validationErrors = new ValidationErrors();
  ...
  validationErrors.add(ValidationError.newError("Value should be positive.", ageField))
  ...
  if (validationErrorCollector.hasErrors()) {
      // take some action
  }
 

Author:
Anton Pechinsky

Field Summary
static ValidationErrors EMPTY
          Empty instance of ValidationErrors
 
Constructor Summary
ValidationErrors(List<ValidationError> validationErrors)
           
ValidationErrors(ValidationError... errors)
           
 
Method Summary
 void add(List<ValidationError> validationErrors)
          Adds all validation errors to this object.
 void add(ValidationError... validationError)
          Adds validation error to this object.
 void clear()
          Clears collected validation errors.
 Set<Object> getErrorContexts()
          Returns form fields with validation errors.
 List<ValidationError> getErrors()
          Return all collected validation errors.
 List<ValidationError> getErrorsFor(Object context)
          Find all validation errors for specified validation context.
 boolean hasErrors()
          Tests if this collector contains at least one validation error.
 String toString(String errorSeparator)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPTY

public static final ValidationErrors EMPTY
Empty instance of ValidationErrors

Constructor Detail

ValidationErrors

public ValidationErrors(List<ValidationError> validationErrors)

ValidationErrors

public ValidationErrors(ValidationError... errors)
Method Detail

clear

public void clear()
Clears collected validation errors.


getErrors

public List<ValidationError> getErrors()
Return all collected validation errors.

Returns:
List list of validation erros.

hasErrors

public boolean hasErrors()
Tests if this collector contains at least one validation error.

Returns:
true if this collection has validation errors, false otherwise.

add

public void add(ValidationError... validationError)
Adds validation error to this object.

Parameters:
validationError - ValidationError to add.

add

public void add(List<ValidationError> validationErrors)
Adds all validation errors to this object.

Parameters:
validationErrors - a List of ValidationError to add.

getErrorContexts

public Set<Object> getErrorContexts()
Returns form fields with validation errors.

Returns:
Set of FormField

getErrorsFor

public List<ValidationError> getErrorsFor(Object context)
Find all validation errors for specified validation context.

Note, comparison is done by references!

Parameters:
context - FormField to find errors for
Returns:
List of ValidationError

toString

public String toString(String errorSeparator)


Copyright © 2014. All Rights Reserved.