com.github.danitutu.painlessjavavalidator

Class ValidationRule

java.lang.Object

com.github.danitutu.painlessjavavalidator.ValidationRule

public class ValidationRule
extends Object

Method Summary

Modifier and Type	Method and Description
static <T> ViolationProvider	after(String field, Comparable<T> value, T other) Checks if the compared value is strictly after the other.
static <T> ViolationProvider	afterOrEqualsTo(String field, Comparable<T> value, T other) Checks if the compared value is after or equals to the other.
static <T> Optional<Violation>	afterOrEqualsToRule(String field, Comparable<T> value, T other) See afterOrEqualsTo(java.lang.String, java.lang.Comparable, java.lang.Object)
static <T> Optional<Violation>	afterRule(String field, Comparable<T> value, T other) See after(java.lang.String, java.lang.Comparable, java.lang.Object)
static <T> ViolationProvider	before(String field, Comparable<T> value, T other) Checks if the compared value is strictly before the other.
static <T> ViolationProvider	beforeOrEqualsTo(String field, Comparable<T> value, T other) Checks if the compared value is before or equals to the other.
static <T> Optional<Violation>	beforeOrEqualsToRule(String field, Comparable<T> value, T other) See beforeOrEqualsTo(java.lang.String, java.lang.Comparable, java.lang.Object)
static <T> Optional<Violation>	beforeRule(String field, Comparable<T> value, T other) See before(java.lang.String, java.lang.Comparable, java.lang.Object)
static ViolationProvider	blank(String field, CharSequence value) Checks if the value is blank.
static Optional<Violation>	blankRule(String field, CharSequence value) See blank(java.lang.String, java.lang.CharSequence)
static <T> ViolationProvider	compareComparable(String field, Comparable<T> value, T other, BiPredicate<Comparable<T>,T> compareFunc, Supplier<Violation> violationFunc)
static <T> Optional<Violation>	compareComparableRule(String field, Comparable<T> value, T other, BiPredicate<Comparable<T>,T> compareFunc, Supplier<Violation> violationFunc) Returns violation in case compare function is true.
static ViolationProvider	compareStrings(String field, String value, String other, BiPredicate<String,String> compareFunc, Supplier<Violation> violationFunc) Compares the two string against a provided rule.
static Optional<Violation>	compareStringsRule(String field, String value, String other, BiPredicate<String,String> compareFunc, Supplier<Violation> violationFunc) Returns violation in case compare function is true.
static ViolationProvider	empty(String field, CharSequence value) Checks if the value is empty.
static Optional<Violation>	emptyRule(String field, CharSequence value) See empty(java.lang.String, java.lang.CharSequence)
static <T> ViolationProvider	equalsTo(String field, Comparable<T> value, T other) Checks if the compared value equals the other.
static ViolationProvider	equalsTo(String field, String value, String other) Checks if the compared value equals the other.
static <T> Optional<Violation>	equalsToRule(String field, Comparable<T> value, T other) See equalsTo(java.lang.String, java.lang.Comparable, java.lang.Object)
static Optional<Violation>	equalsToRule(String field, String value, String other) See equalsTo(java.lang.String, java.lang.String, java.lang.String)
static ViolationProvider	inRange(String field, Integer value, int min, int max) Checks if the value is between or equals to one of the two limits.
static Optional<Violation>	inRangeRule(String field, Integer value, int min, int max) See inRange(java.lang.String, java.lang.Integer, int, int)
static ViolationProvider	isFalse(BooleanSupplier condition, Violation violation) Checks if the condition is evaluated to false.
static Optional<Violation>	isFalseRule(BooleanSupplier condition, Violation violation) See isFalse(java.util.function.BooleanSupplier, com.github.danitutu.painlessjavavalidator.Violation)
static ViolationProvider	isNull(String field, Object value) Checks if the value is null.
static Optional<Violation>	isNullRule(String field, Object value) See isNull(java.lang.String, java.lang.Object)
static ViolationProvider	isTrue(BooleanSupplier condition, Violation violation) Checks if the condition is evaluated to true.
static Optional<Violation>	isTrueRule(BooleanSupplier condition, Violation violation) See isTrue(java.util.function.BooleanSupplier, com.github.danitutu.painlessjavavalidator.Violation)
static ViolationProvider	lengthBetween(String field, CharSequence value, int min, int max) Checks if the value has the length between or equals to one of two limits.
static Optional<Violation>	lengthBetweenRule(String field, CharSequence value, int min, int max) See lengthBetween(java.lang.String, java.lang.CharSequence, int, int)
static ViolationProvider	matchRegex(String field, String value, String regex) Checks if the value matches the provided regex.
static Optional<Violation>	matchRegexRule(String field, String value, String regex) See matchRegex(java.lang.String, java.lang.String, java.lang.String)
static ViolationProvider	max(String field, Integer value, int max) Checks if the value is smaller than or equals to the provided superior limit.
static Optional<Violation>	maxRule(String field, Integer value, int max) See max(java.lang.String, java.lang.Integer, int)
static ViolationProvider	min(String field, Integer value, int min) Checks if the value is grater than or equals to the provided inferior limit.
static Optional<Violation>	minRule(String field, Integer value, int min) See min(java.lang.String, java.lang.Integer, int)
static ViolationProvider	notBlank(String field, CharSequence value) Checks if the value is not blank.
static Optional<Violation>	notBlankRule(String field, CharSequence value) See notBlank(java.lang.String, java.lang.CharSequence)
static ViolationProvider	notEmpty(String field, CharSequence value) Checks if the value is not empty.
static Optional<Violation>	notEmptyRule(String field, CharSequence value) See notEmpty(java.lang.String, java.lang.CharSequence)
static ViolationProvider	notEqualsTo(String field, String value, String other) Checks if the compared value is not equal to the other.
static Optional<Violation>	notEqualsToRule(String field, String value, String other) See notEqualsTo(java.lang.String, java.lang.String, java.lang.String)
static ViolationProvider	notNull(String field, Object value) Checks if the value is not null.
static Optional<Violation>	notNullRule(String field, Object value) See notNull(java.lang.String, java.lang.Object)

Methods inherited from class java.lang.Object

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

Method Detail

isNull

public static ViolationProvider isNull(String field,
                                       Object value)

Checks if the value is null.

Parameters:

field - path to field

value - value to be checked

Returns:

violation or success

isNullRule

public static Optional<Violation> isNullRule(String field,
                                             Object value)

See isNull(java.lang.String, java.lang.Object)

notNull

public static ViolationProvider notNull(String field,
                                        Object value)

Checks if the value is not null.

Parameters:

field - path to field

value - value to be checked

Returns:

violation or success

notNullRule

public static Optional<Violation> notNullRule(String field,
                                              Object value)

See notNull(java.lang.String, java.lang.Object)

isTrue

public static ViolationProvider isTrue(BooleanSupplier condition,
                                       Violation violation)

Checks if the condition is evaluated to true. If not then the violation will be returned.

Parameters:

condition - condition

violation - violation

Returns:

violation or success

Throws:

IllegalArgumentException - in case condition or violation is null

isTrueRule

public static Optional<Violation> isTrueRule(BooleanSupplier condition,
                                             Violation violation)

See isTrue(java.util.function.BooleanSupplier, com.github.danitutu.painlessjavavalidator.Violation)

isFalse

public static ViolationProvider isFalse(BooleanSupplier condition,
                                        Violation violation)

Checks if the condition is evaluated to false. If not then the violation will be returned.

Parameters:

condition - condition

violation - violation

Returns:

violation or success

Throws:

IllegalArgumentException - in case condition or violation is null

isFalseRule

public static Optional<Violation> isFalseRule(BooleanSupplier condition,
                                              Violation violation)

See isFalse(java.util.function.BooleanSupplier, com.github.danitutu.painlessjavavalidator.Violation)

empty

public static ViolationProvider empty(String field,
                                      CharSequence value)

Checks if the value is empty.

Parameters:

field - path to field

value - value to be checked

Returns:

violation or success

emptyRule

public static Optional<Violation> emptyRule(String field,
                                            CharSequence value)

See empty(java.lang.String, java.lang.CharSequence)

notEmpty

public static ViolationProvider notEmpty(String field,
                                         CharSequence value)

Checks if the value is not empty.

Parameters:

field - path to field

value - value to be checked

Returns:

violation or success

notEmptyRule

public static Optional<Violation> notEmptyRule(String field,
                                               CharSequence value)

See notEmpty(java.lang.String, java.lang.CharSequence)

blank

public static ViolationProvider blank(String field,
                                      CharSequence value)

Checks if the value is blank.

Parameters:

field - path to field

value - value to be checked

Returns:

violation or success

blankRule

public static Optional<Violation> blankRule(String field,
                                            CharSequence value)

See blank(java.lang.String, java.lang.CharSequence)

notBlank

public static ViolationProvider notBlank(String field,
                                         CharSequence value)

Checks if the value is not blank.

Parameters:

field - path to field

value - value to be checked

Returns:

violation or success

notBlankRule

public static Optional<Violation> notBlankRule(String field,
                                               CharSequence value)

See notBlank(java.lang.String, java.lang.CharSequence)

lengthBetween

public static ViolationProvider lengthBetween(String field,
                                              CharSequence value,
                                              int min,
                                              int max)

Checks if the value has the length between or equals to one of two limits. The limits can be equal. The value will be checked against notNullRule(java.lang.String, java.lang.Object)

Parameters:

field - path to field

value - value to be checked

min - inferior limit

max - superior limit

Returns:

violation or success

Throws:

IllegalArgumentException - if min is greater than max.

lengthBetweenRule

public static Optional<Violation> lengthBetweenRule(String field,
                                                    CharSequence value,
                                                    int min,
                                                    int max)

See lengthBetween(java.lang.String, java.lang.CharSequence, int, int)

matchRegex

public static ViolationProvider matchRegex(String field,
                                           String value,
                                           String regex)

Checks if the value matches the provided regex. The value will be checked against notNullRule(java.lang.String, java.lang.Object)

Parameters:

field - path to field

value - value to be checked

regex - a valid regex pattern

Returns:

violation or success

matchRegexRule

public static Optional<Violation> matchRegexRule(String field,
                                                 String value,
                                                 String regex)

See matchRegex(java.lang.String, java.lang.String, java.lang.String)

inRange

public static ViolationProvider inRange(String field,
                                        Integer value,
                                        int min,
                                        int max)

Checks if the value is between or equals to one of the two limits. The limits can be equal. The value will be also checked against notNullRule(java.lang.String, java.lang.Object)

Parameters:

field - path to field

value - value to be checked

min - inferior limit

max - superior limit

Returns:

violation or success

Throws:

IllegalArgumentException - if min is greater than max.

inRangeRule

public static Optional<Violation> inRangeRule(String field,
                                              Integer value,
                                              int min,
                                              int max)

See inRange(java.lang.String, java.lang.Integer, int, int)

min

public static ViolationProvider min(String field,
                                    Integer value,
                                    int min)

Checks if the value is grater than or equals to the provided inferior limit. The value will be also checked against notNullRule(java.lang.String, java.lang.Object)

Parameters:

field - path to field

value - value to be checked

min - inferior limit

Returns:

violation or success

minRule

public static Optional<Violation> minRule(String field,
                                          Integer value,
                                          int min)

See min(java.lang.String, java.lang.Integer, int)

max

public static ViolationProvider max(String field,
                                    Integer value,
                                    int max)

Checks if the value is smaller than or equals to the provided superior limit. The value will be also checked against notNullRule(java.lang.String, java.lang.Object)

Parameters:

field - path to field

value - value to be checked

max - superior limit

Returns:

violation or success

maxRule

public static Optional<Violation> maxRule(String field,
                                          Integer value,
                                          int max)

See max(java.lang.String, java.lang.Integer, int)

after

public static <T> ViolationProvider after(String field,
                                          Comparable<T> value,
                                          T other)

Checks if the compared value is strictly after the other. The value will be also checked against notNullRule(java.lang.String, java.lang.Object). If other is null then a violation will be returned.

Type Parameters:

T - compared object type

Parameters:

field - path to field

value - value to be checked

other - other value

Returns:

violation or success

afterRule

public static <T> Optional<Violation> afterRule(String field,
                                                Comparable<T> value,
                                                T other)

See after(java.lang.String, java.lang.Comparable, java.lang.Object)

compareComparableRule

public static <T> Optional<Violation> compareComparableRule(String field,
                                                            Comparable<T> value,
                                                            T other,
                                                            BiPredicate<Comparable<T>,T> compareFunc,
                                                            Supplier<Violation> violationFunc)

Returns violation in case compare function is true. For the first value a notNull validation will also be applied.

Parameters:

field - path to field

value - first value

other - second value

compareFunc - function that compares the two values

violationFunc - the Violation that will be returned

Returns:

violation or success

afterOrEqualsTo

public static <T> ViolationProvider afterOrEqualsTo(String field,
                                                    Comparable<T> value,
                                                    T other)

Checks if the compared value is after or equals to the other. The value will be also checked against notNullRule(java.lang.String, java.lang.Object). If other is null then a violation will be returned.

Type Parameters:

T - compared object type

Parameters:

field - path to field

value - value to be checked

other - other value

Returns:

violation or success

afterOrEqualsToRule

public static <T> Optional<Violation> afterOrEqualsToRule(String field,
                                                          Comparable<T> value,
                                                          T other)

See afterOrEqualsTo(java.lang.String, java.lang.Comparable, java.lang.Object)

before

public static <T> ViolationProvider before(String field,
                                           Comparable<T> value,
                                           T other)

Checks if the compared value is strictly before the other. The value will be also checked against notNullRule(java.lang.String, java.lang.Object). If other is null then a violation will be returned.

Type Parameters:

T - compared object type

Parameters:

field - path to field

value - value to be checked

other - other value

Returns:

violation or success

beforeRule

public static <T> Optional<Violation> beforeRule(String field,
                                                 Comparable<T> value,
                                                 T other)

See before(java.lang.String, java.lang.Comparable, java.lang.Object)

beforeOrEqualsTo

public static <T> ViolationProvider beforeOrEqualsTo(String field,
                                                     Comparable<T> value,
                                                     T other)

Checks if the compared value is before or equals to the other. The value will be also checked against notNullRule(java.lang.String, java.lang.Object). If other is null then a violation will be returned.

Type Parameters:

T - compared object type

Parameters:

field - path to field

value - value to be checked

other - other value

Returns:

violation or success

beforeOrEqualsToRule

public static <T> Optional<Violation> beforeOrEqualsToRule(String field,
                                                           Comparable<T> value,
                                                           T other)

See beforeOrEqualsTo(java.lang.String, java.lang.Comparable, java.lang.Object)

equalsTo

public static <T> ViolationProvider equalsTo(String field,
                                             Comparable<T> value,
                                             T other)

Checks if the compared value equals the other. The value will be also checked against notNullRule(java.lang.String, java.lang.Object). If other is null then a violation will be returned.

Type Parameters:

T - compared object type

Parameters:

field - path to field

value - value to be checked

other - other value

Returns:

violation or success

equalsToRule

public static <T> Optional<Violation> equalsToRule(String field,
                                                   Comparable<T> value,
                                                   T other)

See equalsTo(java.lang.String, java.lang.Comparable, java.lang.Object)

equalsTo

public static ViolationProvider equalsTo(String field,
                                         String value,
                                         String other)

Checks if the compared value equals the other. The value will be also checked against notNullRule(java.lang.String, java.lang.Object). If other is null then a violation will be returned.

Parameters:

field - path to field

value - value to be checked

other - other value

Returns:

violation or success

equalsToRule

public static Optional<Violation> equalsToRule(String field,
                                               String value,
                                               String other)

See equalsTo(java.lang.String, java.lang.String, java.lang.String)

compareStringsRule

public static Optional<Violation> compareStringsRule(String field,
                                                     String value,
                                                     String other,
                                                     BiPredicate<String,String> compareFunc,
                                                     Supplier<Violation> violationFunc)

Returns violation in case compare function is true. For the first value a notNull validation will also be applied.

Parameters:

field - path to field

value - first value

other - second value

compareFunc - function that compares the two values

violationFunc - the Violation that will be returned

Returns:

violation or success

notEqualsTo

public static ViolationProvider notEqualsTo(String field,
                                            String value,
                                            String other)

Checks if the compared value is not equal to the other. The value will be also checked against notNullRule(java.lang.String, java.lang.Object). If other is null then a violation will be returned.

Parameters:

field - path to field

value - value to be checked

other - other value

Returns:

violation or success

notEqualsToRule

public static Optional<Violation> notEqualsToRule(String field,
                                                  String value,
                                                  String other)

See notEqualsTo(java.lang.String, java.lang.String, java.lang.String)

compareStrings

public static ViolationProvider compareStrings(String field,
                                               String value,
                                               String other,
                                               BiPredicate<String,String> compareFunc,
                                               Supplier<Violation> violationFunc)

Compares the two string against a provided rule. If the validation rule is evaluated to true then the provided violation will be returned.

Parameters:

field - path to field

value - value to be checked

other - other value

compareFunc - comparison function

violationFunc - violation to be retrieved when compareFunc evaluates to true

Returns:

violation or success

compareComparable

public static <T> ViolationProvider compareComparable(String field,
                                                      Comparable<T> value,
                                                      T other,
                                                      BiPredicate<Comparable<T>,T> compareFunc,
                                                      Supplier<Violation> violationFunc)