com.opencsv.bean.validators

Interface StringValidator

All Known Implementing Classes:

MustMatchRegexExpression

public interface StringValidator

This is the interface for validators for a single String value.

Currently this is used by the PreAssignmentValidator to check the value of a string before time is taken to convert it.

For post-conversion validation there are already a plethora of third party libraries that can be incorporated into the bean, or you can just modify the setter to validate inputs.

Since:

5.0

Author:

Scott Conway

Method Summary

Modifier and Type	Method and Description
boolean	isValid(String value) Performs the validation check on the string and returns the result.
void	setParameterString(String value) This allows the validator extending StringValidator to be used by multiple fields by allowing you to pass in data for the validator to be used.
void	validate(String value, BeanField field) Performs the validation check on the string and throws an exception if invalid.

Method Detail

isValid

boolean isValid(String value)

Performs the validation check on the string and returns the result.

Parameters:

value - String to be validated

Returns:

true if the value is valid, false otherwise

validate

void validate(String value,
              BeanField field)
       throws CsvValidationException

Performs the validation check on the string and throws an exception if invalid.

Parameters:

value - String to be validated

field - Name of the field in the bean. This will be used in the CsvValidationException if the value is not valid.

Throws:

CsvValidationException - If the input is invalid. Should contain a message describing the error.

setParameterString

void setParameterString(String value)

This allows the validator extending StringValidator to be used by multiple fields by allowing you to pass in data for the validator to be used.

Those data might be forbidden characters or regular expressions, to name two possibilities.

If the validator needs multiple parameters, then you will need to combine them into a single string using some sort of delimiter, say a comma, and parse them out using some library that allows you to parse such strings 😁.

If the validator does not need a value then just create an empty method like the MustStartWithACapitalLetter validator used by the BeanFieldValidatorTest.

Parameters:

value - Information used by the validator to validate the string