com.vaadin.data.validator
Class StringLengthValidator

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

All Implemented Interfaces:

Validator, Serializable

public class StringLengthValidator
extends AbstractValidator

This StringLengthValidator is used to validate the length of strings.

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

Constructor Summary

StringLengthValidator(String errorMessage)
Creates a new StringLengthValidator with a given error message.

StringLengthValidator(String errorMessage, int minLength, int maxLength, boolean allowNull)
Creates a new StringLengthValidator with a given error message, permissable lengths and null-string allowance.

Method Summary

int	getMaxLength() Gets the maximum permissible length of the string.
int	getMinLength() Gets the minimum permissible length of the string.
boolean	isNullAllowed() Deprecated.
boolean	isValid(Object value) Checks if the given value is valid.
void	setMaxLength(int maxLength) Sets the maximum permissible length of the string.
void	setMinLength(int minLength) Sets the minimum permissible length.
void	setNullAllowed(boolean allowNull) Deprecated.

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

getErrorMessage, setErrorMessage, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

StringLengthValidator

public StringLengthValidator(String errorMessage)

Creates a new StringLengthValidator with a given error message.

Parameters:

errorMessage - the message to display in case the value does not validate.

StringLengthValidator

public StringLengthValidator(String errorMessage,
                             int minLength,
                             int maxLength,
                             boolean allowNull)

Creates a new StringLengthValidator with a given error message, permissable lengths and null-string allowance.

Parameters:

errorMessage - the message to display in case the value does not validate.

minLength - the minimum permissible length of the string.

maxLength - the maximum permissible length of the string.

allowNull - Are null strings permissible? This can be handled better by setting a field as required or not.

Method Detail

isValid

public boolean isValid(Object value)

Checks if the given value is valid.

Parameters:

value - the value to validate.

Returns:

true for valid value, otherwise false.

isNullAllowed

@Deprecated
public final boolean isNullAllowed()

Deprecated.

Returns true if null strings are allowed.

Returns:

true if allows null string, otherwise false.

getMaxLength

public final int getMaxLength()

Gets the maximum permissible length of the string.

Returns:

the maximum length of the string.

getMinLength

public final int getMinLength()

Gets the minimum permissible length of the string.

Returns:

the minimum length of the string.

setNullAllowed

@Deprecated
public void setNullAllowed(boolean allowNull)

Deprecated.

Sets whether null-strings are to be allowed. This can be better handled by setting a field as required or not.

setMaxLength

public void setMaxLength(int maxLength)

Sets the maximum permissible length of the string.

Parameters:

maxLength - the length to set.

setMinLength

public void setMinLength(int minLength)

Sets the minimum permissible length.

Parameters:

minLength - the length to set.