io.validly

Class ValidationEngineString

java.lang.Object

io.validly.ValidationEngine<java.lang.String,ValidationEngineString>

io.validly.ValidationEngineString

public final class ValidationEngineString
extends ValidationEngine<java.lang.String,ValidationEngineString>

Validation engine for String type value. Provides convenience methods for String validation predicate.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ValidationEngineString(java.lang.String value)
protected	ValidationEngineString(java.lang.String value, java.util.List<java.lang.String> note)
protected	ValidationEngineString(java.lang.String fieldName, java.lang.String value, ValidlyNote note)

Method Summary

Modifier and Type	Method and Description
ValidationEngineString	lengthMustBeAtLeast(int min, java.lang.String message) Set a value with length less than the min to be considered as invalid.
ValidationEngineString	lengthMustBeWithin(int min, int max, java.lang.String message) Convenience method for defining max and min lengths
ValidationEngineString	lengthMustNotExceed(int max, java.lang.String message) Set a value with length greater than the max to be considered as invalid.
ValidationEngineString	must(java.util.function.Predicate<java.lang.String> predicate, java.lang.String message) Set the value for which the predicate test returns false to be considered as invalid.
ValidationEngineString	mustContain(java.lang.CharSequence value, java.lang.String message) Set a value that does not contain String.contains(java.lang.CharSequence) the provided sequence of char values to be considered as invalid.
ValidationEngineString	mustStartWith(java.lang.String value, java.lang.String message) Set value that does not start with String.startsWith(java.lang.String, int) the provided string to be considered invalid.

Methods inherited from class io.validly.ValidationEngine

mustConvert, mustFatally, setFailOnFirst, setStopValidation, when, when

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationEngineString

protected ValidationEngineString(java.lang.String value)

ValidationEngineString

protected ValidationEngineString(java.lang.String fieldName,
                                 java.lang.String value,
                                 ValidlyNote note)

ValidationEngineString

protected ValidationEngineString(java.lang.String value,
                                 java.util.List<java.lang.String> note)

Method Detail

lengthMustNotExceed

public ValidationEngineString lengthMustNotExceed(int max,
                                                  java.lang.String message)

Set a value with length greater than the max to be considered as invalid. valid: v.length() less or equal than max

Parameters:

max - maximum valid value

message - validation error

Returns:

validation engines

lengthMustBeAtLeast

public ValidationEngineString lengthMustBeAtLeast(int min,
                                                  java.lang.String message)

Set a value with length less than the min to be considered as invalid. valid: v.length() greater or equal than min

Parameters:

min - minimum valid value

message - validation error

Returns:

validation engines

lengthMustBeWithin

public ValidationEngineString lengthMustBeWithin(int min,
                                                 int max,
                                                 java.lang.String message)

Convenience method for defining max and min lengths

lengthMustBeWithin(1, 3) is same as: lengthMustBeAtLeast(1) AND lengthMustNotExceed(3)

Parameters:

min - minimum value

max - maximum value

message - validation error

Returns:

validation engine

mustContain

public ValidationEngineString mustContain(java.lang.CharSequence value,
                                          java.lang.String message)

Set a value that does not contain String.contains(java.lang.CharSequence) the provided sequence of char values to be considered as invalid.

Parameters:

value - the sequence to search for

message - validation error

Returns:

validation engine

mustStartWith

public ValidationEngineString mustStartWith(java.lang.String value,
                                            java.lang.String message)

Set value that does not start with String.startsWith(java.lang.String, int) the provided string to be considered invalid.

Parameters:

value - the string to search for

message - validation error

Returns:

validation engine

must

public ValidationEngineString must(java.util.function.Predicate<java.lang.String> predicate,
                                   java.lang.String message)

Description copied from class: ValidationEngine

Set the value for which the predicate test returns false to be considered as invalid.

Overrides:

must in class ValidationEngine<java.lang.String,ValidationEngineString>

Parameters:

predicate - predicate the evaluate

message - validation error

Returns:

validation engine