org.jamesframework.core.subset.validations

Class SubsetValidation

java.lang.Object

org.jamesframework.core.subset.validations.SubsetValidation

All Implemented Interfaces:

Validation

public class SubsetValidation
extends Object
implements Validation

Represents a validation of a subset solution. Separately indicates whether the subset has a valid size, in addition to the general mandatory constraint validation. It can be checked whether the subset passed validation, possibly ignoring its size.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
SubsetValidation(boolean validSize, Validation constraintValidation) Create a subset validation.

Method Summary

Modifier and Type	Method and Description
Validation	getConstraintValidation() Get the validation object produced when checking the general mandatory constraints (may be null).
boolean	passed() Check whether the subset solution passed validation, taking into account both its size and the general mandatory constraint validations (if not null).
boolean	passed(boolean checkSize) Check whether the subset solution passed validation.
String	toString() Get a string representation of the validation object.
boolean	validSize() Check whether the subset solution has a valid size.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubsetValidation

public SubsetValidation(boolean validSize,
                        Validation constraintValidation)

Create a subset validation.

Parameters:

validSize - indicates whether the subset has a valid size

constraintValidation - validation object produced when checking the general mandatory constraints (may be null)

Method Detail

validSize

public boolean validSize()

Check whether the subset solution has a valid size.

Returns:

true if the subset has a valid size

getConstraintValidation

public Validation getConstraintValidation()

Get the validation object produced when checking the general mandatory constraints (may be null).

Returns:

mandatory constraint validation object

passed

public boolean passed(boolean checkSize)

Check whether the subset solution passed validation. If checkSize is false the size of the subset is ignored and only the general mandatory constraints are checked (if not null).

Parameters:

checkSize - indicates whether the size should be validated

Returns:

true if the subset solution is valid, possibly ignoring its size

passed

public boolean passed()

Check whether the subset solution passed validation, taking into account both its size and the general mandatory constraint validations (if not null).

Specified by:

passed in interface Validation

Returns:

true if the subset has a valid size and satisfies all mandatory constraints (if any)

toString

public String toString()

Get a string representation of the validation object. Indicates whether the general mandatory constraints are satisfied (if any) and whether the subset has a valid size.

Overrides:

toString in class Object

Returns:

string representation