com.github.kamikazbee.rules

Class LengthRule

java.lang.Object

com.github.kamikazbee.rules.LengthRule

All Implemented Interfaces:

Rule<java.lang.String,LengthRule>

public class LengthRule
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
LengthRule()

Method Summary

Modifier and Type	Method and Description
R	blocking(boolean blocking) Define whether the Rule is blocking or not.
LengthRule	exact(java.lang.Number exact)
protected java.lang.String	getMessage() Get the error message
protected java.util.function.Predicate<java.lang.String>	getValidation() Get the validation contract
boolean	isBlocking() Check whether the Rule is blocking or not.
LengthRule	max(java.lang.Number max)
R	message(java.lang.String message) Define the custom error message added in the RuleResponse when the Rule validation fails.
LengthRule	min(java.lang.Number min)
R	optional(boolean optional) Define whether the Rule is optional or not.
protected boolean	skipValidation(T value) Determine whether validation should be skipped for the given value
RuleResponse	validate(T value) Validate a given value using this Rule
protected R	validation(java.util.function.Predicate<T> validation) Provides the validation to be performed in order to determine whether the value is valid

Methods inherited from class java.lang.Object

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

Constructor Detail

LengthRule

public LengthRule()

Method Detail

min

public LengthRule min(java.lang.Number min)

max

public LengthRule max(java.lang.Number max)

exact

public LengthRule exact(java.lang.Number exact)

getMessage

protected java.lang.String getMessage()

Get the error message

Returns:

String with the error message for that Rule

getValidation

protected java.util.function.Predicate<java.lang.String> getValidation()

Get the validation contract

Returns:

Predicate with the rule contract

message

public R message(java.lang.String message)

Description copied from interface: Rule

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

Specified by:

message in interface Rule<T,R extends Rule>

Parameters:

message - String with custom error message

Returns:

the Rule

validation

protected R validation(java.util.function.Predicate<T> validation)

Provides the validation to be performed in order to determine whether the value is valid

Parameters:

validation - a Predicate that is the contract to when a value is valid

Returns:

the Rule

blocking

public R blocking(boolean blocking)

Description copied from interface: Rule

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.

Specified by:

blocking in interface Rule<T,R extends Rule>

Parameters:

blocking - boolean denoting whether Rule is blocking or null

Returns:

the Rule

optional

public R optional(boolean optional)

Description copied from interface: Rule

Define whether the Rule is optional or not.

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

Specified by:

optional in interface Rule<T,R extends Rule>

Parameters:

optional - boolean denoting whether Rule is optional

Returns:

the Rule

validate

public RuleResponse validate(T value)

Description copied from interface: Rule

Validate a given value using this Rule

Specified by:

validate in interface Rule<T,R extends Rule>

Parameters:

value - object to be validated

Returns:

RuleResponse containing the result of the Rule application

skipValidation

protected boolean skipValidation(T value)

Determine whether validation should be skipped for the given value

Parameters:

value - the object for which the validation will take place

Returns:

boolean denoting whether validation should be skipped

isBlocking

public boolean isBlocking()

Description copied from interface: Rule

Check whether the Rule is blocking or not.

Specified by:

isBlocking in interface Rule<T,R extends Rule>

Returns:

boolean to determine whether Rule is blocking