net.sf.mmm.util.validation.base

Class AbstractValidator<V>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

ValueValidator<V>

Direct Known Subclasses:

AbstractValueValidator, ComposedValidator, ValidatorCollectionElements, ValidatorJsr303, ValidatorMapKeys, ValidatorMapValues, ValidatorNone

public abstract class AbstractValidator<V>
extends Object
implements ValueValidator<V>

This is the abstract base class all ValueValidator implementations should extend.

Since:

3.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static TypedProperty<Boolean>	PROPERTY_MANDATORY Property for mandatory flag.
static TypedProperty<Comparable>	PROPERTY_MAXIMUM Property for maximum value (null if unbounded).
static TypedProperty<Comparable>	PROPERTY_MINIMUM Property for minimum value (null if unbounded).

Constructor Summary

Constructors

Constructor and Description
AbstractValidator() The constructor.

Method Summary

Modifier and Type	Method and Description
AbstractValidator<V>	append(AbstractValidator<? super V>... validators)
boolean	contains(AbstractValidator<?> validator)
protected <BUNDLE extends NlsBundle> BUNDLE	createBundle(Class<BUNDLE> bundleInterface) This is a convenience method delegating to NlsBundleFactory.createBundle(Class).
abstract boolean	equals(Object obj)
protected String	getCode() This is the default implementation to retrieve the code of this ValueValidator.
<P> P	getProperty(TypedProperty<P> property) Gets the value of a property.
abstract int	hashCode()
boolean	isDynamic() This method determines if this ValueValidator is dynamic.
boolean	isMandatory()
ValidationFailure	validate(V value) This method validates the given value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.validation.api.ValueValidator

validate

Field Detail

PROPERTY_MANDATORY

public static final TypedProperty<Boolean> PROPERTY_MANDATORY

Property for mandatory flag.

PROPERTY_MINIMUM

public static final TypedProperty<Comparable> PROPERTY_MINIMUM

Property for minimum value (null if unbounded).

PROPERTY_MAXIMUM

public static final TypedProperty<Comparable> PROPERTY_MAXIMUM

Property for maximum value (null if unbounded).

Constructor Detail

AbstractValidator

public AbstractValidator()

The constructor.

Method Detail

getCode

protected String getCode()

This is the default implementation to retrieve the code of this ValueValidator.
ATTENTION:
This default implementation returns the classname of the actual ValueValidator implementation. This strategy is chosen for simplicity when implementing a new validator. To ensure stable codes override this method and return a string constant. This shall at least be done when the name of the class is changed.

Returns:

the code.

validate

public final ValidationFailure validate(V value)

Description copied from interface: ValueValidator

This method validates the given value.

Specified by:

validate in interface ValueValidator<V>

Parameters:

value - is the value to validate.

Returns:

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

isDynamic

public boolean isDynamic()

This method determines if this ValueValidator is dynamic. Here dynamic means that the validation of the same input may not always return the same validation result (e.g. it holds references to instances that have dynamic impact on the validation).

Returns:

true if this ValueValidator is dynamic, false otherwise.

isMandatory

public final boolean isMandatory()

Returns:

true if this is a validator for mandatory fields (that will not accept null or empty values), false otherwise.

createBundle

protected <BUNDLE extends NlsBundle> BUNDLE createBundle(Class<BUNDLE> bundleInterface)

This is a convenience method delegating to NlsBundleFactory.createBundle(Class).

Type Parameters:

BUNDLE - is the generic type of the requested NlsBundle.

Parameters:

bundleInterface - the interface of the requested NlsBundle. Has to be a sub-interface of NlsBundle with according methods.

Returns:

an instance of the requested NlsBundle interface.

Since:

3.1.0

getProperty

public <P> P getProperty(TypedProperty<P> property)

Gets the value of a property.

Type Parameters:

P - the generic type of the requested property.

Parameters:

property - the TypedProperty.

Returns:

the requested value or null if undefined.

Since:

7.1.0

contains

public boolean contains(AbstractValidator<?> validator)

Parameters:

validator - the validator to check.

Returns:

true if the given validator is equal to this validator or one of its descendents, false otherwise.

append

public AbstractValidator<V> append(AbstractValidator<? super V>... validators)

Parameters:

validators - the validators to append.

Returns:

a new ComposedValidator instance composing the current validator (this) with the given validator.

equals

public abstract boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object