com.github.kamikazbee.rules

Interface Rule<T,R extends Rule>

Type Parameters:

T - The Class of the value to be validated

R - A Rule Class itself, used for generic purposes

All Known Implementing Classes:

EmptyRule, LengthRule, NonNullRule, QuantityRule, RegexRule

public interface Rule<T,R extends Rule>

The Rule is the base class of the validation library. It is in simple words the check that will be applied in order to determine whether a value is valid or not.

Method Summary

Modifier and Type	Method and Description
R	blocking(boolean blocking) Define whether the Rule is blocking or not.
boolean	isBlocking() Check whether the Rule is blocking or not.
R	message(java.lang.String message) Define the custom error message added in the RuleResponse when the Rule validation fails.
R	optional(boolean optional) Define whether the Rule is optional or not.
RuleResponse	validate(T value) Validate a given value using this Rule

Method Detail

message

R message(java.lang.String message)

Define the custom error message added in the RuleResponse when the Rule validation fails.

Parameters:

message - String with custom error message

Returns:

the Rule

blocking

R blocking(boolean blocking)

Define whether the Rule is blocking or not.

When a blocking Rule is being processed in the Rules chain and fails, the validation immediately stops for the given Object (at the given level) and immediately returns without continuing to the next Rules.

Parameters:

blocking - boolean denoting whether Rule is blocking or null

Returns:

the Rule

optional

R optional(boolean optional)

Define whether the Rule is optional or not.

An optional Rule is being skipped when the value to be validated is null.

Parameters:

optional - boolean denoting whether Rule is optional

Returns:

the Rule

validate

RuleResponse validate(T value)

Validate a given value using this Rule

Parameters:

value - object to be validated

Returns:

RuleResponse containing the result of the Rule application

isBlocking

boolean isBlocking()

Check whether the Rule is blocking or not.

Returns:

boolean to determine whether Rule is blocking