Package io.mangoo.routing.bindings

Class Validator

java.lang.Object

io.mangoo.routing.bindings.Validator

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Form, Request

public class Validator
extends Object
implements Serializable

Author:

svenkubiak

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Validator()

Method Summary

Modifier and Type	Method	Description
void	addValue(String key, String value)
void	expectDomainName(String name)	Validates a field to be a valid IPv4 address
void	expectDomainName(String name, String message)	Validates a field to be a valid IPv4 address
void	expectEmail(String name)	Validates a field to be a valid email address
void	expectEmail(String name, String message)	Validates a field to be a valid email address
void	expectExactMatch(String name, String anotherName)	Validates to fields to exactly (case-sensitive) match
void	expectExactMatch(String name, String anotherName, String message)	Validates to fields to exactly (case-sensitive) match
void	expectIpv4(String name)	Validates a field to be a valid IPv4 address
void	expectIpv4(String name, String message)	Validates a field to be a valid IPv4 address
void	expectIpv6(String name)	Validates a field to be a valid IPv6 address
void	expectIpv6(String name, String message)	Validates a field to be a valid IPv6 address
void	expectMatch(String name, String anotherName)	Validates to fields to (case-insensitive) match
void	expectMatch(String name, String anotherName, String message)	Validates to fields to (case-insensitive) match
void	expectMatch(String name, String message, List<String> values)	Validates to fields to (case-sensitive) match
void	expectMatch(String name, List<String> values)	Validates to list of given values to (case-sensitive) match
void	expectMax(String name, double maxLength)	Validates a given field to have a maximum length
void	expectMax(String name, double maxLength, String message)	Validates a given field to have a maximum length
void	expectMin(String name, double minLength)	Validates a given field to have a minimum length
void	expectMin(String name, double minLength, String message)	Validates a given field to have a minimum length
void	expectNumeric(String name)	Validates that a given field has a numeric value
void	expectNumeric(String name, String message)	Validates that a given field has a numeric value
void	expectRange(String name, int minLength, int maxLength)	Validates a field to be in a certain range
void	expectRange(String name, int minLength, int maxLength, String message)	Validates a field to be in a certain range
void	expectRegex(String name, com.google.re2j.Pattern pattern)	Validates a field by a given regular expression pattern It is required to pass a pre-compiled pattern, e.g.
void	expectRegex(String name, com.google.re2j.Pattern pattern, String message)	Validates a field by a given regular expression pattern It is required to pass a pre-compiled pattern, e.g.
void	expectUrl(String name)	Validates field to be a valid URL
void	expectUrl(String name, String message)	Validates field to be a valid URL
void	expectValue(String name)	Validates a given field to be present with a value
void	expectValue(String name, String message)	Validates a given field to be present with a value
String	get(String key)	Retrieves a form value corresponding to the name of the form element
String	getError(String name)	Retrieves the error message for a given field
Map<String,String>	getErrors()
boolean	hasError(String name)	Checks if a give field has a validation error
boolean	hasErrors()	Checks if any field in the validation has an error
void	invalidate()
boolean	isValid()
void	setValues(Map<String,String> values)
void	validateFalse(boolean value, String name)	Validates a given value to be false
void	validateFalse(boolean value, String name, String message)	Validates a given value to be false
void	validateNotNull(Object object, String name)	Validates a given object to be not null
void	validateNotNull(Object object, String name, String message)	Validates a given object to be not null
void	validateNull(Object object, String name)	Validates a given object to be null
void	validateNull(Object object, String name, String message)	Validates a given object to be null
void	validateTrue(boolean value, String name)	Validates a given value to be true
void	validateTrue(boolean value, String name, String message)	Validates a given value to be true

Methods inherited from class java.lang.Object

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

Constructor Detail

Validator

public Validator()

Method Detail

hasError

public boolean hasError(String name)

Checks if a give field has a validation error

Parameters:

name - The field to check

Returns:

True if the field has a validation error, false otherwise

getError

public String getError(String name)

Retrieves the error message for a given field

Parameters:

name - The field to check

Returns:

The error message for the field, or an empty string if no error is found

expectValue

public void expectValue(String name)

Validates a given field to be present with a value

Parameters:

name - The field to check

expectValue

public void expectValue(String name,
                        String message)

Validates a given field to be present with a value

Parameters:

name - The field to check

message - A custom error message instead of the default one

expectMin

public void expectMin(String name,
                      double minLength)

Validates a given field to have a minimum length

Parameters:

name - The field to check

minLength - The minimum length

expectMin

public void expectMin(String name,
                      double minLength,
                      String message)

Validates a given field to have a minimum length

Parameters:

name - The field to check

minLength - The minimum length

message - A custom error message instead of the default one

expectMax

public void expectMax(String name,
                      double maxLength)

Validates a given field to have a maximum length

Parameters:

maxLength - The maximum length

name - The field to check

expectNumeric

public void expectNumeric(String name)

Validates that a given field has a numeric value

Parameters:

name - The field to check

expectNumeric

public void expectNumeric(String name,
                          String message)

Validates that a given field has a numeric value

Parameters:

name - The field to check

message - A custom error message instead of the default one

expectMax

public void expectMax(String name,
                      double maxLength,
                      String message)

Validates a given field to have a maximum length

Parameters:

name - The field to check

maxLength - The maximum length

message - A custom error message instead of the default one

expectExactMatch

public void expectExactMatch(String name,
                             String anotherName)

Validates to fields to exactly (case-sensitive) match

Parameters:

name - The field to check

anotherName - The other field to check against

expectExactMatch

public void expectExactMatch(String name,
                             String anotherName,
                             String message)

Validates to fields to exactly (case-sensitive) match

Parameters:

name - The field to check

anotherName - The other field to check against

message - A custom error message instead of the default one

expectMatch

public void expectMatch(String name,
                        String anotherName)

Validates to fields to (case-insensitive) match

Parameters:

name - The field to check

anotherName - The field to check against

expectMatch

public void expectMatch(String name,
                        String anotherName,
                        String message)

Validates to fields to (case-insensitive) match

Parameters:

name - The field to check

anotherName - The field to check against

message - A custom error message instead of the default one

expectMatch

public void expectMatch(String name,
                        List<String> values)

Validates to list of given values to (case-sensitive) match

Parameters:

name - The field to check

values - A list of given values to check against

expectMatch

public void expectMatch(String name,
                        String message,
                        List<String> values)

Validates to fields to (case-sensitive) match

Parameters:

name - The field to check

message - A custom error message instead of the default one

values - A list of given values to check against

expectEmail

public void expectEmail(String name)

Validates a field to be a valid email address

Parameters:

name - The field to check

expectEmail

public void expectEmail(String name,
                        String message)

Validates a field to be a valid email address

Parameters:

name - The field to check

message - A custom error message instead of the default one

expectIpv4

public void expectIpv4(String name)

Validates a field to be a valid IPv4 address

Parameters:

name - The field to check

expectIpv4

public void expectIpv4(String name,
                       String message)

Validates a field to be a valid IPv4 address

Parameters:

name - The field to check

message - A custom error message instead of the default one

expectDomainName

public void expectDomainName(String name)

Validates a field to be a valid IPv4 address

Parameters:

name - The field to check

expectDomainName

public void expectDomainName(String name,
                             String message)

Validates a field to be a valid IPv4 address

Parameters:

name - The field to check

message - A custom error message instead of the default one

expectIpv6

public void expectIpv6(String name)

Validates a field to be a valid IPv6 address

Parameters:

name - The field to check

expectIpv6

public void expectIpv6(String name,
                       String message)

Validates a field to be a valid IPv6 address

Parameters:

name - The field to check

message - A custom error message instead of the default one

expectRange

public void expectRange(String name,
                        int minLength,
                        int maxLength)

Validates a field to be in a certain range

Parameters:

name - The field to check

minLength - The minimum length

maxLength - The maximum length

expectRange

public void expectRange(String name,
                        int minLength,
                        int maxLength,
                        String message)

Validates a field to be in a certain range

Parameters:

name - The field to check

minLength - The minimum length

maxLength - The maximum length

message - A custom error message instead of the default one

expectRegex

public void expectRegex(String name,
                        com.google.re2j.Pattern pattern)

Validates a field by a given regular expression pattern It is required to pass a pre-compiled pattern, e.g. Pattern pattern = Pattern.compile("[a-Z,0-9]")

Parameters:

name - The field to check

pattern - The pre-compiled pattern

expectRegex

public void expectRegex(String name,
                        com.google.re2j.Pattern pattern,
                        String message)

Validates a field by a given regular expression pattern It is required to pass a pre-compiled pattern, e.g. Pattern pattern = Pattern.compile("[a-Z,0-9]")

Parameters:

pattern - The pre-compiled pattern

name - The field to check

message - A custom error message instead of the default one

expectUrl

public void expectUrl(String name)

Validates field to be a valid URL

Parameters:

name - The field to check

expectUrl

public void expectUrl(String name,
                      String message)

Validates field to be a valid URL

Parameters:

name - The field to check

message - A custom error message instead of the default one

validateTrue

public void validateTrue(boolean value,
                         String name,
                         String message)

Validates a given value to be true

Parameters:

value - The value to check

name - The name of the field to display the error message

message - A custom error message instead of the default one

validateTrue

public void validateTrue(boolean value,
                         String name)

Validates a given value to be true

Parameters:

value - The value to check

name - The name of the field to display the error message

validateFalse

public void validateFalse(boolean value,
                          String name,
                          String message)

Validates a given value to be false

Parameters:

value - The value to check

name - The name of the field to display the error message

message - A custom error message instead of the default one

validateFalse

public void validateFalse(boolean value,
                          String name)

Validates a given value to be false

Parameters:

value - The value to check

name - The name of the field to display the error message

validateNotNull

public void validateNotNull(Object object,
                            String name,
                            String message)

Validates a given object to be not null

Parameters:

object - The object to check

name - The name of the field to display the error message

message - A custom error message instead of the default one

validateNotNull

public void validateNotNull(Object object,
                            String name)

Validates a given object to be not null

Parameters:

object - The object to check

name - The name of the field to display the error message

validateNull

public void validateNull(Object object,
                         String name,
                         String message)

Validates a given object to be null

Parameters:

object - The object to check

name - The name of the field to display the error message

message - A custom error message instead of the default one

validateNull

public void validateNull(Object object,
                         String name)

Validates a given object to be null

Parameters:

object - The object to check

name - The name of the field to display the error message

hasErrors

public boolean hasErrors()

Checks if any field in the validation has an error

Returns:

True if at least one field has an error, false otherwise

get

public String get(String key)

Retrieves a form value corresponding to the name of the form element

Parameters:

key - The name of the form element

Returns:

The value of the form or null if not present

getErrors

public Map<String,String> getErrors()

setValues

public void setValues(Map<String,String> values)

addValue

public void addValue(String key,
                     String value)

isValid

public boolean isValid()

invalidate

public void invalidate()