com.univocity.parsers.annotations

Annotation Type Validate

@Retention(value=RUNTIME)
 @Inherited
 @Target(value={FIELD,METHOD,ANNOTATION_TYPE})
public @interface Validate

Performs basic validations against the String representation of the value found in the annotated field. A validation failure will generate a DataValidationException. By default, nulls and blanks are not allowed.

Commonly used for java beans processed using BeanProcessor and/or BeanWriterProcessor

Author:

Univocity Software Pty Ltd - parsers@univocity.com

See Also:

Conversion, Conversions, BeanProcessor, BeanWriterProcessor

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowBlanks Indicates whether this field can be blank (i.e.
String	matches Ensures that the value of this field matches a given regular expression.
String[]	noneOf Ensures that the value of this field does is not an unwanted value.
boolean	nullable Indicates whether this field can be null
String[]	oneOf Ensures that the value of this field is one of a given set of alternatives
Class<? extends Validator>[]	validators User provided implementations of Validator which will be executed in sequence after the validations specified in this annotation execute.

Element Detail

nullable

public abstract boolean nullable

Indicates whether this field can be null

Returns:

true true if nulls are allowed, false otherwise

Default:

false

allowBlanks

public abstract boolean allowBlanks

Indicates whether this field can be blank (i.e. contain 0 or more whitespaces, where a whitespace is any character <= ' '

Returns:

true true if blanks are allowed, false otherwise

Default:

false

matches

public abstract String matches

Ensures that the value of this field matches a given regular expression.

Returns:

the regular expression that determines an expected format for the given value

Default:

""

oneOf

public abstract String[] oneOf

Ensures that the value of this field is one of a given set of alternatives

Returns:

the sequence of allowed values

Default:

{}

noneOf

public abstract String[] noneOf

Ensures that the value of this field does is not an unwanted value.

Returns:

the sequence of disallowed values

Default:

{}

validators

public abstract Class<? extends Validator>[] validators

User provided implementations of Validator which will be executed in sequence after the validations specified in this annotation execute.

Returns:

custom classes to be used to validate any value associated with this field.

Default:

{}