net.sf.mmm.util.validation.base

Class ValidatorMandatory

java.lang.Object

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

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

net.sf.mmm.util.validation.base.ValidatorMandatory

All Implemented Interfaces:

ValueValidator<Object>

public class ValidatorMandatory
extends AbstractValueValidator<Object>

This is a ValueValidator that validates that a mandatory value is filled. It will produce a ValidationFailure if the value is not provided (empty, blank, null).

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CODE
private static ValidatorMandatory	INSTANCE

Constructor Summary

Constructors

Constructor and Description
ValidatorMandatory() The constructor.

Method Summary

Modifier and Type	Method and Description
protected String	getCode() This is the default implementation to retrieve the code of this ValueValidator.
private NlsMessage	getFailureMessage()
static ValidatorMandatory	getInstance()
boolean	isMandatory()
protected NlsMessage	validateNotNull(Object 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.AbstractValueValidator

validate

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

createBundle, isDynamic, validate

Methods inherited from class java.lang.Object

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

Field Detail

CODE

public static final String CODE

See Also:

getCode(), Constant Field Values

INSTANCE

private static final ValidatorMandatory INSTANCE

See Also:

getInstance()

Constructor Detail

ValidatorMandatory

public ValidatorMandatory()

The constructor.

Method Detail

isMandatory

public boolean isMandatory()

Overrides:

isMandatory in class AbstractValidator<Object>

Returns:

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

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.

Overrides:

getCode in class AbstractValidator<Object>

Returns:

the code.

getInstance

public static ValidatorMandatory getInstance()

Returns:

the singleton instance of this class.

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.

Overrides:

validateNull in class AbstractValueValidator<Object>

Returns:

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

getFailureMessage

private NlsMessage getFailureMessage()

Returns:

the failure message.

validateNotNull

protected NlsMessage validateNotNull(Object 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.

Specified by:

validateNotNull in class AbstractValueValidator<Object>

Parameters:

value - is the value to validate.

Returns:

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