com.vaadin.data.validator

Class NullValidator

java.lang.Object

com.vaadin.data.validator.NullValidator

All Implemented Interfaces:

Validator, Serializable

public class NullValidator
extends Object
implements Validator

This validator is used for validating properties that do or do not allow null values. By default, nulls are not allowed.

Since:

3.0

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.data.Validator

Validator.EmptyValueException, Validator.InvalidValueException

Constructor Summary

Constructors

Constructor and Description
NullValidator(String errorMessage, boolean onlyNullAllowed) Creates a new NullValidator.

Method Summary

Modifier and Type	Method and Description
String	getErrorMessage() Gets the error message that is displayed in case the value is invalid.
boolean	isNullAllowed() Returns true if nulls are allowed otherwise false.
void	setErrorMessage(String errorMessage) Sets the error message to be displayed on invalid value.
void	setNullAllowed(boolean onlyNullAllowed) Sets if nulls (and only nulls) are to be allowed.
void	validate(Object value) Validates the data given in value.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullValidator

public NullValidator(String errorMessage,
                     boolean onlyNullAllowed)

Creates a new NullValidator.

Parameters:

errorMessage - the error message to display on invalidation.

onlyNullAllowed - Are only nulls allowed?

Method Detail

validate

public void validate(Object value)
              throws Validator.InvalidValueException

Validates the data given in value.

Specified by:

validate in interface Validator

Parameters:

value - the value to validate.

Throws:

Validator.InvalidValueException - if the value was invalid.

isNullAllowed

public final boolean isNullAllowed()

Returns true if nulls are allowed otherwise false.

setNullAllowed

public void setNullAllowed(boolean onlyNullAllowed)

Sets if nulls (and only nulls) are to be allowed.

Parameters:

onlyNullAllowed - If true, only nulls are allowed. If false only non-nulls are allowed. Do we allow nulls?

getErrorMessage

public String getErrorMessage()

Gets the error message that is displayed in case the value is invalid.

Returns:

the Error Message.

setErrorMessage

public void setErrorMessage(String errorMessage)

Sets the error message to be displayed on invalid value.

Parameters:

errorMessage - the Error Message to set.