com.vaadin.data.validator.

Class CompositeValidator

java.lang.Object
  com.vaadin.data.validator.AbstractValidator
      com.vaadin.data.validator.CompositeValidator

All Implemented Interfaces:

Validator, Serializable

extends AbstractValidator

The CompositeValidator allows you to chain (compose) many validators to validate one field. The contained validators may be required to all validate the value to validate or it may be enough that one contained validator validates the value. This behaviour is controlled by the modes AND and OR.

Since:

3.0

Version:

6.8.18

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.data.Validator
`Validator.EmptyValueException, Validator.InvalidValueException`

Field Summary
`static int`	`MODE_AND` The validators are combined with `AND` clause: validity of the composite implies validity of the all validators it is composed of must be valid.
`static int`	`MODE_DEFAULT` The validators are combined with and clause: validity of the composite implies validity of the all validators it is composed of
`static int`	`MODE_OR` The validators are combined with `OR` clause: validity of the composite implies that some of validators it is composed of must be valid.

Constructor Summary
`CompositeValidator()` Construct a composite validator in `AND` mode without error message.
`CompositeValidator(int mode, String errorMessage)` Constructs a composite validator in given mode.

Method Summary
`void`	`addValidator(Validator validator)` Adds validator to the interface.
`String`	`getErrorMessage()` Gets the error message for the composite validator.
`int`	`getMode()` Gets the mode of the validator.
`Collection<Validator>`	`getSubValidators(Class validatorType)` Gets sub-validators by class.
`boolean`	`isValid(Object value)` Checks the validity of the the given value.
`void`	`removeValidator(Validator validator)` Removes a validator from the composite.
`void`	`setMode(int mode)` Sets the mode of the validator.
`void`	`validate(Object value)` Validates the given value.

Methods inherited from class com.vaadin.data.validator.AbstractValidator
`setErrorMessage`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

MODE_AND

public static final int MODE_AND

The validators are combined with AND clause: validity of the composite implies validity of the all validators it is composed of must be valid.

See Also:: Constant Field Values

MODE_OR

public static final int MODE_OR

The validators are combined with OR clause: validity of the composite implies that some of validators it is composed of must be valid.

See Also:: Constant Field Values

MODE_DEFAULT

public static final int MODE_DEFAULT

The validators are combined with and clause: validity of the composite implies validity of the all validators it is composed of

See Also:: Constant Field Values

Constructor Detail

CompositeValidator

public CompositeValidator()

Construct a composite validator in AND mode without error message.

CompositeValidator

public CompositeValidator(int mode,
                          String errorMessage)

Constructs a composite validator in given mode.

Method Detail

validate

public void validate(Object value)
              throws Validator.InvalidValueException

Validates the given value.

The value is valid, if:

MODE_AND: All of the sub-validators are valid
MODE_OR: Any of the sub-validators are valid

If the value is invalid, validation error is thrown. If the error message is set (non-null), it is used. If the error message has not been set, the first error occurred is thrown.

Specified by:: validate in interface Validator
Overrides:: validate in class AbstractValidator

Parameters:: value - the value to check.
Throws:: Validator.InvalidValueException - if the value is not valid.

isValid

public boolean isValid(Object value)

Checks the validity of the the given value. The value is valid, if:

MODE_AND: All of the sub-validators are valid
MODE_OR: Any of the sub-validators are valid

Parameters:: value - the value to check.
Returns:: true if the value is valid, false otherwise.

getMode

public final int getMode()

Gets the mode of the validator.

Returns:: Operation mode of the validator: MODE_AND or MODE_OR.

setMode

public void setMode(int mode)

Sets the mode of the validator. The valid modes are:

MODE_AND (default)
MODE_OR

Parameters:: mode - the mode to set.

getErrorMessage

public String getErrorMessage()

Gets the error message for the composite validator. If the error message is null, original error messages of the sub-validators are used instead.

Overrides:: getErrorMessage in class AbstractValidator

Returns:: the error message provided in the constructor or using AbstractValidator.setErrorMessage(String).

addValidator

public void addValidator(Validator validator)

Adds validator to the interface.

Parameters:: validator - the Validator object which performs validation checks on this set of data field values.

removeValidator

public void removeValidator(Validator validator)

Removes a validator from the composite.

Parameters:: validator - the Validator object which performs validation checks on this set of data field values.

getSubValidators

public Collection<Validator> getSubValidators(Class validatorType)

Gets sub-validators by class.

If the component contains directly or recursively (it contains another composite containing the validator) validators compatible with given type they are returned. This only applies to AND mode composite validators.

If the validator is in OR mode or does not contain any validators of given type null is returned.

Returns:: Collection of validators compatible with given type that must apply or null if none fould.