io.doov.core.dsl

Class DOOV

java.lang.Object

io.doov.core.dsl.DOOV

public class DOOV
extends java.lang.Object

Entry point of the DSL.

All validation rules will start with the when(StepCondition) method. Then you can create a step condition either by referencing a FieldInfo that you generated (in the example below it's userEmail) or by using a composition method like matchAll(StepCondition...).

 DOOV.when(userEmail().matches("...")).validate();
 

Method Summary

Modifier and Type	Method and Description
static StepCondition	alwaysFalse() Returns a condition that is always false.
static StepCondition	alwaysFalse(java.lang.String readable) Returns a condition that is always false.
static StepCondition	alwaysTrue() Returns a condition that is always true.
static StepCondition	alwaysTrue(java.lang.String readable) Returns a condition that is always true.
static IntegerFunction	count(StepCondition... steps) Returns an integer condition that returns the number of given conditions that evaluates to true.
static <T,F extends Function<T>> F	fieldFunction(DslField<T> field, java.util.function.BiFunction<FieldMetadata<?>,java.util.function.BiFunction<FieldModel,Context,java.util.Optional<T>>,F> constructorRef) Wrap given field into a function using the given function constructor reference
static <T extends DslField<?>> T	fieldInPosition(java.util.stream.Stream<T> fieldStream, int index) Returns the field in the position
static <T> IterableFunction<T,java.util.List<T>>	lift(T... value) Wrap given value into a function using the given function constructor reference Ex.
static <T,F extends Function<T>,M extends ValuePredicateMetadata<M>> F	lift(T value, java.util.function.BiFunction<ValuePredicateMetadata,java.util.function.BiFunction<FieldModel,Context,java.util.Optional<T>>,F> constructorRef) Wrap given value into a function using the given function constructor reference Ex.
static <I> ContextawareStepMap<I>	map(java.util.function.BiFunction<FieldModel,Context,I> valueFunction) Start defining a context-aware value mapping
static <I,J> BiContextawareStepMap<I,J>	map(java.util.function.BiFunction<FieldModel,Context,I> valueFunction, java.util.function.BiFunction<FieldModel,Context,J> valueFunction2) Start defining a context-aware value mapping
static NaryStepMap	map(DslField<?>... inFieldInfos) Start defining a nary mapping
static <I> SimpleStepMap<I>	map(DslField<I> inFieldInfo) Start defining a mapping
static <I,J> BiStepMap<I,J>	map(DslField<I> inFieldInfo, DslField<J> in2FieldInfo) Start defining a bi mapping
static <I> StaticStepMap<I>	map(I value) Start defining a value mapping
static <I> ContextawareStepMap<I>	map(MappingInput<I> input) Start defining a context-aware value mapping
static <I,J> BiContextawareStepMap<I,J>	map(MappingInput<I> input, MappingInput<J> input2) Start defining a context-aware value mapping
static NaryStepMap	map(java.util.stream.Stream<? extends DslField<?>> inFieldInfos) Start defining a nary mapping
static <I> StaticStepMap<I>	map(java.util.function.Supplier<I> valueSupplier) Start defining a value mapping
static <T extends DslField<?>> MappingRegistry	mapFor(java.util.stream.Stream<T> fieldStream, java.util.function.Function<T,MappingRule> mappingRuleFunction) Create an array of mapping rules from a stream of fields
static <I,C extends java.lang.Iterable<I>> IterableStepMap<I,C>	mapIter(C value) Start defining a value mapping for an Iterable field
static <I> IterableStepMap<I,java.util.List<I>>	mapIter(I... values) Start defining a value mapping to form an Iterable field as a List
static <O> MappingRule	mapNull(DslField<O> outFieldInfo) Start defining a value mapping with value null
static MappingRegistry	mappings(MappingRule... mappingRules) Create a mapping registry from given mapping rules See MappingRegistry.mappings(MappingRule...)
static MappingRegistry	mapRange(int startInclusive, int endExclusive, java.util.function.Function<java.lang.Integer,MappingRule> mappingRuleFunction) Create an array of mapping rules from a range of index
static <T extends DslField<?>> MappingRegistry	mapWithIndex(java.util.stream.Stream<T> fieldStream, java.util.function.BiFunction<T,java.lang.Integer,MappingRule> mappingRuleFunction) Create an array of mapping rules from a stream of fields with index
static StepCondition	matchAll(StepCondition... steps) See LogicalNaryCondition.matchAll(List)
static StepCondition	matchAll(java.util.stream.Stream<? extends DslField<?>> dslFields, java.util.function.Function<DefaultFunction<?,?>,StepCondition> stepConditionFunction) See LogicalNaryCondition.matchAll(List)
static StepCondition	matchAny(StepCondition... steps) See LogicalNaryCondition.matchAny(List)
static StepCondition	matchAny(java.util.stream.Stream<? extends DslField<?>> dslFields, java.util.function.Function<DefaultFunction<?,?>,StepCondition> stepConditionFunction) See LogicalNaryCondition.matchAny(List)
static StepCondition	matchNone(StepCondition... steps) See LogicalNaryCondition.matchNone(List)
static StepCondition	matchNone(java.util.stream.Stream<? extends DslField<?>> dslFields, java.util.function.Function<DefaultFunction<?,?>,StepCondition> stepConditionFunction) See LogicalNaryCondition.matchNone(List)
static <N extends java.lang.Number> NumericFunction<N>	min(NumericFieldInfo<N>... fields) See NumericFunction.min(List)
static StepCondition	not(StepCondition step) See LogicalUnaryCondition.negate(StepCondition)}
static <N extends java.lang.Number> NumericFunction<N>	sum(NumericFieldInfo<N>... fields) See NumericFunction.sum(List)
static <N extends java.lang.Number> NumericFunction<N>	sum(NumericFunction<N>... conditions) See NumericFunction.sum(List)
static <T1 extends DslField<?>> TemplateSpec.Template1<T1>	template(java.util.function.Supplier<TemplateParam<T1>> param1)
static <T1 extends DslField<?>,T2 extends DslField<?>> TemplateSpec.Template2<T1,T2>	template(java.util.function.Supplier<TemplateParam<T1>> param1, java.util.function.Supplier<TemplateParam<T2>> param2)
static <T1 extends DslField<?>,T2 extends DslField<?>,T3 extends DslField<?>> TemplateSpec.Template3<T1,T2,T3>	template(java.util.function.Supplier<TemplateParam<T1>> param1, java.util.function.Supplier<TemplateParam<T2>> param2, java.util.function.Supplier<TemplateParam<T3>> param3)
static <T1 extends DslField<?>,T2 extends DslField<?>,T3 extends DslField<?>,T4 extends DslField<?>> TemplateSpec.Template4<T1,T2,T3,T4>	template(java.util.function.Supplier<TemplateParam<T1>> param1, java.util.function.Supplier<TemplateParam<T2>> param2, java.util.function.Supplier<TemplateParam<T3>> param3, java.util.function.Supplier<TemplateParam<T4>> param4)
static <T1 extends DslField<?>,T2 extends DslField<?>,T3 extends DslField<?>,T4 extends DslField<?>,T5 extends DslField<?>> TemplateSpec.Template5<T1,T2,T3,T4,T5>	template(java.util.function.Supplier<TemplateParam<T1>> param1, java.util.function.Supplier<TemplateParam<T2>> param2, java.util.function.Supplier<TemplateParam<T3>> param3, java.util.function.Supplier<TemplateParam<T4>> param4, java.util.function.Supplier<TemplateParam<T5>> param5)
static StepWhen	when(StepCondition condition) Returns a step when with the given condition.

Methods inherited from class java.lang.Object

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

Method Detail

when

public static StepWhen when(StepCondition condition)

Returns a step when with the given condition. This is the main entry point of the DSL.

Parameters:

condition - the condition

Returns:

the step when

alwaysTrue

public static StepCondition alwaysTrue()

Returns a condition that is always true.

Returns:

the step condition

alwaysTrue

public static StepCondition alwaysTrue(java.lang.String readable)

Returns a condition that is always true.

Parameters:

readable - that describes the condition

Returns:

the step condition

alwaysFalse

public static StepCondition alwaysFalse()

Returns a condition that is always false.

Returns:

the step condition

alwaysFalse

public static StepCondition alwaysFalse(java.lang.String readable)

Returns a condition that is always false.

Parameters:

readable - that describes the condition

Returns:

the step condition

count

public static IntegerFunction count(StepCondition... steps)

Returns an integer condition that returns the number of given conditions that evaluates to true.

Parameters:

steps - the steps to match

Returns:

the integer condition

matchAny

public static StepCondition matchAny(StepCondition... steps)

See LogicalNaryCondition.matchAny(List)

Parameters:

steps - the steps to match

Returns:

the step condition

See Also:

LogicalNaryCondition.matchAny(List)

not

public static StepCondition not(StepCondition step)

See LogicalUnaryCondition.negate(StepCondition)}

Parameters:

step - the step to negate

Returns:

the step condition

matchAny

public static StepCondition matchAny(java.util.stream.Stream<? extends DslField<?>> dslFields,
                                     java.util.function.Function<DefaultFunction<?,?>,StepCondition> stepConditionFunction)

See LogicalNaryCondition.matchAny(List)

Parameters:

dslFields - stream of fields

stepConditionFunction - condition to apply

Returns:

step condition

matchAll

public static StepCondition matchAll(StepCondition... steps)

See LogicalNaryCondition.matchAll(List)

Parameters:

steps - the steps to match

Returns:

the step condition

See Also:

LogicalNaryCondition.matchAll(List)

matchAll

public static StepCondition matchAll(java.util.stream.Stream<? extends DslField<?>> dslFields,
                                     java.util.function.Function<DefaultFunction<?,?>,StepCondition> stepConditionFunction)

See LogicalNaryCondition.matchAll(List)

Parameters:

dslFields - stream of fields

stepConditionFunction - condition to apply

Returns:

step condition

matchNone

public static StepCondition matchNone(StepCondition... steps)

See LogicalNaryCondition.matchNone(List)

Parameters:

steps - the steps to match

Returns:

the step condition

See Also:

LogicalNaryCondition.matchNone(List)

matchNone

public static StepCondition matchNone(java.util.stream.Stream<? extends DslField<?>> dslFields,
                                      java.util.function.Function<DefaultFunction<?,?>,StepCondition> stepConditionFunction)

See LogicalNaryCondition.matchNone(List)

Parameters:

dslFields - stream of fields

stepConditionFunction - condition to apply

Returns:

step condition

map

public static <I> SimpleStepMap<I> map(DslField<I> inFieldInfo)

Start defining a mapping

Type Parameters:

I - in type

Parameters:

inFieldInfo - in field

Returns:

map step

map

public static <I,J> BiStepMap<I,J> map(DslField<I> inFieldInfo,
                                       DslField<J> in2FieldInfo)

Start defining a bi mapping

Type Parameters:

I - in type

J - in type 2

Parameters:

inFieldInfo - in field

in2FieldInfo - in field 2

Returns:

bi map step

map

public static NaryStepMap map(DslField<?>... inFieldInfos)

Start defining a nary mapping

Parameters:

inFieldInfos - list of in fields

Returns:

nary map step

map

public static NaryStepMap map(java.util.stream.Stream<? extends DslField<?>> inFieldInfos)

Start defining a nary mapping

Parameters:

inFieldInfos - list of in fields

Returns:

nary map step

map

public static <I> StaticStepMap<I> map(java.util.function.Supplier<I> valueSupplier)

Start defining a value mapping

Type Parameters:

I - value type

Parameters:

valueSupplier - value supplier

Returns:

value map step

map

public static <I> StaticStepMap<I> map(I value)

Start defining a value mapping

Type Parameters:

I - value type

Parameters:

value - value

Returns:

value step map

mapIter

public static <I,C extends java.lang.Iterable<I>> IterableStepMap<I,C> mapIter(C value)

Start defining a value mapping for an Iterable field

Type Parameters:

I - value type

C - container type

Parameters:

value - value

Returns:

value step map

mapIter

@SafeVarargs
public static <I> IterableStepMap<I,java.util.List<I>> mapIter(I... values)

Start defining a value mapping to form an Iterable field as a List

Type Parameters:

I - value type

Parameters:

values - values to add to the list

Returns:

value step map

mapNull

public static <O> MappingRule mapNull(DslField<O> outFieldInfo)

Start defining a value mapping with value null

Type Parameters:

O - value type

Parameters:

outFieldInfo - output field

Returns:

value map step

map

public static <I> ContextawareStepMap<I> map(java.util.function.BiFunction<FieldModel,Context,I> valueFunction)

Start defining a context-aware value mapping

Type Parameters:

I - value type

Parameters:

valueFunction - context dependent value function

Returns:

value map step

map

public static <I> ContextawareStepMap<I> map(MappingInput<I> input)

Start defining a context-aware value mapping

Type Parameters:

I - value type

Parameters:

input - mapping input

Returns:

value map step

map

public static <I,J> BiContextawareStepMap<I,J> map(MappingInput<I> input,
                                                   MappingInput<J> input2)

Start defining a context-aware value mapping

Type Parameters:

I - value type

J - value type 2

Parameters:

input - mapping input

input2 - mapping input

Returns:

value map step

map

public static <I,J> BiContextawareStepMap<I,J> map(java.util.function.BiFunction<FieldModel,Context,I> valueFunction,
                                                   java.util.function.BiFunction<FieldModel,Context,J> valueFunction2)

Start defining a context-aware value mapping

Type Parameters:

I - value type

J - value type

Parameters:

valueFunction - context dependent value function

valueFunction2 - context dependent value function

Returns:

value map step

mappings

public static MappingRegistry mappings(MappingRule... mappingRules)

Create a mapping registry from given mapping rules See MappingRegistry.mappings(MappingRule...)

Parameters:

mappingRules - rules

Returns:

mapping registry containing rules

mapRange

public static MappingRegistry mapRange(int startInclusive,
                                       int endExclusive,
                                       java.util.function.Function<java.lang.Integer,MappingRule> mappingRuleFunction)

Create an array of mapping rules from a range of index

Parameters:

startInclusive - inclusive start index, inclusive

endExclusive - exclusive end index

mappingRuleFunction - index to mapping rule function

Returns:

mapping registry containing rules

mapFor

public static <T extends DslField<?>> MappingRegistry mapFor(java.util.stream.Stream<T> fieldStream,
                                                             java.util.function.Function<T,MappingRule> mappingRuleFunction)

Create an array of mapping rules from a stream of fields

Type Parameters:

T - field info type

Parameters:

fieldStream - field stream

mappingRuleFunction - field to mapping rule function

Returns:

mapping registry containing rules

mapWithIndex

public static <T extends DslField<?>> MappingRegistry mapWithIndex(java.util.stream.Stream<T> fieldStream,
                                                                   java.util.function.BiFunction<T,java.lang.Integer,MappingRule> mappingRuleFunction)

Create an array of mapping rules from a stream of fields with index

Type Parameters:

T - field info type

Parameters:

fieldStream - field stream

mappingRuleFunction - field to mapping rule function with index in integer

Returns:

mapping registry containing rules

fieldInPosition

public static <T extends DslField<?>> T fieldInPosition(java.util.stream.Stream<T> fieldStream,
                                                        int index)

Returns the field in the position

Type Parameters:

T - field info type

Parameters:

fieldStream - field stream

index - field list position

Returns:

field info

min

@SafeVarargs
public static <N extends java.lang.Number> NumericFunction<N> min(NumericFieldInfo<N>... fields)

See NumericFunction.min(List)

Type Parameters:

N - the type of the field infos

Parameters:

fields - the fields to minimize

Returns:

the numeric condition

See Also:

NumericFunction.min(List)

sum

@SafeVarargs
public static <N extends java.lang.Number> NumericFunction<N> sum(NumericFieldInfo<N>... fields)

See NumericFunction.sum(List)

Type Parameters:

N - the type of the field infos

Parameters:

fields - the fields to sum

Returns:

the numeric condition

See Also:

NumericFunction.sum(List)

sum

@SafeVarargs
public static <N extends java.lang.Number> NumericFunction<N> sum(NumericFunction<N>... conditions)

See NumericFunction.sum(List)

Type Parameters:

N - the type of the field infos

Parameters:

conditions - the conditions to sum

Returns:

the numeric condition

See Also:

NumericFunction.sum(List)

template

public static <T1 extends DslField<?>> TemplateSpec.Template1<T1> template(java.util.function.Supplier<TemplateParam<T1>> param1)

template

public static <T1 extends DslField<?>,T2 extends DslField<?>> TemplateSpec.Template2<T1,T2> template(java.util.function.Supplier<TemplateParam<T1>> param1,
                                                                                                     java.util.function.Supplier<TemplateParam<T2>> param2)

template

public static <T1 extends DslField<?>,T2 extends DslField<?>,T3 extends DslField<?>> TemplateSpec.Template3<T1,T2,T3> template(java.util.function.Supplier<TemplateParam<T1>> param1,
                                                                                                                               java.util.function.Supplier<TemplateParam<T2>> param2,
                                                                                                                               java.util.function.Supplier<TemplateParam<T3>> param3)

template

public static <T1 extends DslField<?>,T2 extends DslField<?>,T3 extends DslField<?>,T4 extends DslField<?>> TemplateSpec.Template4<T1,T2,T3,T4> template(java.util.function.Supplier<TemplateParam<T1>> param1,
                                                                                                                                                         java.util.function.Supplier<TemplateParam<T2>> param2,
                                                                                                                                                         java.util.function.Supplier<TemplateParam<T3>> param3,
                                                                                                                                                         java.util.function.Supplier<TemplateParam<T4>> param4)

template

public static <T1 extends DslField<?>,T2 extends DslField<?>,T3 extends DslField<?>,T4 extends DslField<?>,T5 extends DslField<?>> TemplateSpec.Template5<T1,T2,T3,T4,T5> template(java.util.function.Supplier<TemplateParam<T1>> param1,
                                                                                                                                                                                   java.util.function.Supplier<TemplateParam<T2>> param2,
                                                                                                                                                                                   java.util.function.Supplier<TemplateParam<T3>> param3,
                                                                                                                                                                                   java.util.function.Supplier<TemplateParam<T4>> param4,
                                                                                                                                                                                   java.util.function.Supplier<TemplateParam<T5>> param5)

lift

public static <T,F extends Function<T>,M extends ValuePredicateMetadata<M>> F lift(T value,
                                                                                   java.util.function.BiFunction<ValuePredicateMetadata,java.util.function.BiFunction<FieldModel,Context,java.util.Optional<T>>,F> constructorRef)

Wrap given value into a function using the given function constructor reference Ex.

 StringFunction function = DOOV.lift(value, StringFunction::new);
 

Type Parameters:

T - value type

F - function type

M - valuemetadata type

Parameters:

value - value

constructorRef - function constructor reference

Returns:

function that wraps the given value

lift

@SafeVarargs
public static <T> IterableFunction<T,java.util.List<T>> lift(T... value)

Wrap given value into a function using the given function constructor reference Ex.

 IterableFunction<Integer, List<Integer>> function = DOOV.lift(1, 2, 3, 4);
 

Type Parameters:

T - value type

Parameters:

value - value

Returns:

function that wraps the given value

fieldFunction

public static <T,F extends Function<T>> F fieldFunction(DslField<T> field,
                                                        java.util.function.BiFunction<FieldMetadata<?>,java.util.function.BiFunction<FieldModel,Context,java.util.Optional<T>>,F> constructorRef)

Wrap given field into a function using the given function constructor reference

Type Parameters:

T - field value type

F - function type

Parameters:

field - field

constructorRef - function constructor reference

Returns:

function that wraps the given field