net.sf.mmm.util.validation.base

Class ValidationStateMessageCollector

java.lang.Object

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

net.sf.mmm.util.validation.base.ValidationStateMessageCollector

All Implemented Interfaces:

ValidationCollector, ValidationState

public class ValidationStateMessageCollector
extends AbstractValidationStateCollector

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

 public boolean validate(ValidationState state) {

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

   ValidationStateMessageCollector messageCollector = new ValidationStateMessageCollector(state);
   validateRecursive(messageCollector);
   String messages = messageCollector.getFailureMessages();
   if (messages != null) {
     setTooltip(messages);
     setStyle("invalid");
   } else {
     setTooltip("");
     setStyle("valid");
   }
   return messageCollector.isValid();
 }
 

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private StringBuilder	failureMessages
private String	separator

Constructor Summary

Constructors

Constructor and Description
ValidationStateMessageCollector(ValidationState delegate) The constructor.
ValidationStateMessageCollector(ValidationState delegate, String separator) The constructor.

Method Summary

Modifier and Type	Method and Description
String	getFailureMessages() This method gets the collected messages separated with the separator.
String	getSeparator() This method gets the String used to separate individual validation failure messages for getFailureMessages().
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

separator

private final String separator

failureMessages

private StringBuilder failureMessages

Constructor Detail

ValidationStateMessageCollector

public ValidationStateMessageCollector(ValidationState delegate)

The constructor.

Parameters:

delegate - is the ValidationState to adapt.

ValidationStateMessageCollector

public ValidationStateMessageCollector(ValidationState delegate,
                                       String separator)

The constructor.

Parameters:

delegate - is the ValidationState to adapt.

separator - is the separator.

Method Detail

getSeparator

public String getSeparator()

This method gets the String used to separate individual validation failure messages for getFailureMessages().

Returns:

the separator.

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.

getFailureMessages

public String getFailureMessages()

This method gets the collected messages separated with the separator.

Returns:

the failure messages or null if valid.

toString

public String toString()

Overrides:

toString in class Object