net.sf.mmm.util.validation.base

Class AbstractValueValidator<V>

java.lang.Object

net.sf.mmm.util.validation.base.AbstractValidator<V>

net.sf.mmm.util.validation.base.AbstractValueValidator<V>

Type Parameters:

V - is the generic type of the value to validate.

All Implemented Interfaces:

ValueValidator<V>

Direct Known Subclasses:

AbstractValidatorRange, ValidatorCompare, ValidatorDateFuture, ValidatorDatePast, ValidatorMandatory, ValidatorPattern, ValidatorTimeAfter, ValidatorTimeBefore, ValidatorTimeFuture, ValidatorTimePast

public abstract class AbstractValueValidator<V>
extends AbstractValidator<V>

This is the abstract base implementation of ValueValidator.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from class net.sf.mmm.util.validation.base.AbstractValidator

PROPERTY_MANDATORY, PROPERTY_MAXIMUM, PROPERTY_MINIMUM

Constructor Summary

Constructors

Constructor and Description
AbstractValueValidator() The constructor.

Method Summary

Modifier and Type	Method and Description
ValidationFailure	validate(V value, Object valueSource) This method validates the given value.
protected abstract NlsMessage	validateNotNull(V value) This method performs the validation in case value is NOT null.
protected NlsMessage	validateNull() This method performs the validation in case null was provided as value.

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

append, contains, createBundle, equals, getCode, getProperty, hashCode, isDynamic, isMandatory, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractValueValidator

public AbstractValueValidator()

The constructor.

Method Detail

validate

public ValidationFailure validate(V value,
                                  Object valueSource)

Description copied from interface: ValueValidator

This method validates the given value.

Parameters:

value - is the value to validate.

valueSource - is the source describing the origin of the given value. This may be the filename where the value was read from, an XPath where the value was located in an XML document, the label of a widget of the UI containing the value, etc. This will help to find the problem easier. The source needs to have a reasonable string-representation as this may be displayed to the end-user to locate the source of the failure. In most cases it is suitable to directly pass a String.

Returns:

the ValidationFailure or null if the given value is valid according to this ValueValidator.

validateNull

protected NlsMessage validateNull()

This method performs the validation in case null was provided as value. By default null should be considered as a legal value. Only for validators such as ValidatorMandatory this method should be overridden.

Returns:

the failure message or null if the null -value is valid.

validateNotNull

protected abstract NlsMessage validateNotNull(V value)

This method performs the validation in case value is NOT null. This method contains the actual custom logic for the validation. It is therefore designed in a way that makes it most simple to implement custom validators.
ATTENTION:
For internationalization you should not directly return string literals but use NlsMessage instead.

Parameters:

value - is the value to validate.

Returns:

the failure message or null if the the given value is valid.