net.sf.mmm.util.validation.base

Class ValidationStateFailureCollector

java.lang.Object

net.sf.mmm.util.validation.base.AbstractValidationStateCollector

net.sf.mmm.util.validation.base.ValidationStateFailureCollector

All Implemented Interfaces:

ValidationCollector, ValidationState

public class ValidationStateFailureCollector
extends AbstractValidationStateCollector

This is an implementation of ValidationState that wraps an existing ValidationState and allows to collect the potential failures for a part of the validation process.
Example:

 public boolean validate(ValidationState state) {

   if (state == null) {
     state = new ValidationStateImpl();
   }

   ValidationStateFailureCollector failureCollector = new ValidationStateFailureCollector(state);
   validateRecursive(failureCollector);
   List<ValidationFailure> childFailureList = failureCollector.getFailureList();
   if (!childFailureList.isEmpty()) {
     applyValidationFailures(childFailureList);
   }
   return failureCollector.isValid();
 }
 

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private List<ValidationFailure>	failureList

Constructor Summary

Constructors

Constructor and Description
ValidationStateFailureCollector(ValidationState delegate) The constructor.

Method Summary

Modifier and Type	Method and Description
List<ValidationFailure>	getFailureList() This method gets the List with the ValidationFailures collected during validation.
boolean	isValid() This method determines if the validation has been successful.
void	onFailure(ValidationFailure failure) This method gets called if a ValidationFailure occurred.
String	toString()

Methods inherited from class net.sf.mmm.util.validation.base.AbstractValidationStateCollector

getDelegate, getFailureCount

Methods inherited from class java.lang.Object

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

Field Detail

failureList

private final List<ValidationFailure> failureList

Constructor Detail

ValidationStateFailureCollector

public ValidationStateFailureCollector(ValidationState delegate)

The constructor.

Parameters:

delegate - is the ValidationState to adapt.

Method Detail

onFailure

public void onFailure(ValidationFailure failure)

Description copied from interface: ValidationCollector

This method gets called if a ValidationFailure occurred.

Specified by:

onFailure in interface ValidationCollector

Overrides:

onFailure in class AbstractValidationStateCollector

Parameters:

failure - is the new ValidationFailure.

isValid

public boolean isValid()

Description copied from class: AbstractValidationStateCollector

This method determines if the validation has been successful.
ATTENTION:
This method only returns false if a ValidationFailure has been collected by this instance. It may therefore return true even if the delegate would return false.

Specified by:

isValid in interface ValidationState

Overrides:

isValid in class AbstractValidationStateCollector

Returns:

true if no ValidationFailure has been collected, false otherwise.

getFailureList

public List<ValidationFailure> getFailureList()

This method gets the List with the ValidationFailures collected during validation.

Returns:

the List of ValidationFailures.

toString

public String toString()

Overrides:

toString in class Object