org.jamesframework.core.problems.constraints.validations

Class UnanimousValidation

java.lang.Object

org.jamesframework.core.problems.constraints.validations.UnanimousValidation

All Implemented Interfaces:

Validation

public class UnanimousValidation
extends Object
implements Validation

A unanimous validation object is used to combine validations produced by a number of constraints. A solution passes a unanimous validation if and only if it passes each contained validation.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
UnanimousValidation() Create an empty unanimous validation object.

Method Summary

Modifier and Type	Method and Description
void	addValidation(Object key, Validation validation) Add a validation object.
Validation	getValidation(Object key) Retrieve the validation object corresponding to the given key.
boolean	passed() A unanimous validation passed if and only if all contained validations passed.
String	toString() Get a string representation of the validation object.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnanimousValidation

public UnanimousValidation()

Create an empty unanimous validation object. Actual underlying validations can be added later by calling addValidation(Object, Validation).

Method Detail

addValidation

public void addValidation(Object key,
                          Validation validation)

Add a validation object. A key is required that can be used to retrieve the validation object.

Parameters:

key - key used to retrieve the validation object

validation - validation object

getValidation

public Validation getValidation(Object key)

Retrieve the validation object corresponding to the given key. If no validation with this key has been added, null is returned.

Parameters:

key - key specified when adding the validation

Returns:

retrieved validation object, null if no validation with this key was added

passed

public boolean passed()

A unanimous validation passed if and only if all contained validations passed. The returned value is only guaranteed to be correct if the validation objects have not been modified after they were added to this unanimous validation.

Specified by:

passed in interface Validation

Returns:

true if all contained validations passed

toString

public String toString()

Get a string representation of the validation object. If validation passed, a string "valid" is returned, else "invalid" is returned.

Overrides:

toString in class Object

Returns:

string representation ("valid"/"invalid")