DefaultFunction (doov-core 2.7.8 API)

java.lang.Object
- io.doov.core.dsl.impl.DefaultFunction<T,M>

All Implemented Interfaces:

ContextAccessor<T>, Function<T>, DSLBuilder, MappingInput<T>, Readable

Direct Known Subclasses:

BooleanFunction, IterableFunction, NumericFunction, StringFunction, TemporalFunction
```
public class DefaultFunction<T,M extends Metadata>
extends java.lang.Object
implements Function<T>
```

Field Summary

Fields
Modifier and Type Field and Description

protected java.util.function.BiFunction<FieldModel,Context,java.util.Optional<T>> function

protected M metadata

Fields
Modifier and Type	Field and Description
`protected java.util.function.BiFunction<FieldModel,Context,java.util.Optional<T>>`	`function`
`protected M`	`metadata`

Constructor Summary

Constructors
Constructor and Description

DefaultFunction(M metadata, java.util.function.BiFunction<FieldModel,Context,java.util.Optional<T>> function)

Constructors
Constructor and Description
`DefaultFunction(M metadata, java.util.function.BiFunction<FieldModel,Context,java.util.Optional<T>> function)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`StepCondition`	`allMatch(java.util.Collection<T> values)` Returns a step condition checking if the node value matches all of the given values.
`StepCondition`	`allMatch(java.util.List<java.util.function.Predicate<T>> values, java.lang.String... predicateReadables)` Returns a step condition checking if all of the given predicates testing the node value match.
`StepCondition`	`allMatch(T... values)` Returns a step condition checking if the node value matches all of the given values.
`StepCondition`	`anyMatch(java.util.Collection<T> values)` Returns a step condition checking if the node value matches any of the given values.
`StepCondition`	`anyMatch(java.util.List<java.util.function.Predicate<T>> values, java.lang.String... predicateReadables)` Returns a step condition checking if any of the given predicates testing the node value match.
`StepCondition`	`anyMatch(T... values)` Returns a step condition checking if the node value matches any of the given values.
`StepCondition`	`eq(BaseFieldInfo<T> value)` Returns a step condition checking if the node value is equal to the given supplier value.
`StepCondition`	`eq(Function<T> value)` Returns a step condition checking if the node value is equal to the given supplier value.
`StepCondition`	`eq(java.util.function.Supplier<T> supplier)` Deprecated. use `eq(Object)` or `eq(Function)` instead
`StepCondition`	`eq(T value)` Returns a step condition checking if the node value is equal to the given value.
`java.util.function.BiFunction<FieldModel,Context,java.util.Optional<T>>`	`getFunction()`
`M`	`getMetadata()`
`StepCondition`	`isNotNull()` Returns a step condition checking if the node value is not null.
`StepCondition`	`isNull()` Returns a step condition checking if the node value is null.
`<R> DefaultFunction<R,MapFunctionMetadata>`	`map(java.lang.String readable, java.util.function.Function<T,R> mapper)` Returns a default step condition that returns the node value mapped by the given function.
`IntegerFunction`	`mapToInt(java.util.function.Function<T,java.lang.Integer> mapper)` Deprecated. use `mapToInt(String, java.util.function.Function)` instead
`IntegerFunction`	`mapToInt(java.lang.String readable, java.util.function.Function<T,java.lang.Integer> mapper)` Returns an integer step condition that returns the node value mapped by the given mapper.
`StringFunction`	`mapToString(java.util.function.Function<T,java.lang.String> mapper)` Deprecated. use `mapToString(String, java.util.function.Function)` instead
`StringFunction`	`mapToString(java.lang.String readable, java.util.function.Function<T,java.lang.String> mapper)` Returns a string step condition that returns the node value mapped by the given function.
`<U,R> DefaultFunction<R,MapFunctionMetadata>`	`mapUsing(java.lang.String readable, Function<U> condition, java.util.function.BiFunction<T,U,R> mapper)` Returns an default step condition that returns the node value mapped by the given function.
`StepCondition`	`noneMatch(java.util.Collection<T> values)` Returns a step condition checking if the node value matches none of the given values.
`StepCondition`	`noneMatch(java.util.List<java.util.function.Predicate<T>> values, java.lang.String... predicateReadables)` Returns a step condition checking if none of the given predicates testing the node value match.
`StepCondition`	`noneMatch(T... values)` Returns a step condition checking if the node value matches none of the given values.
`StepCondition`	`notEq(BaseFieldInfo<T> value)` Returns a step condition checking if the node value is not equal to the given field value.
`StepCondition`	`notEq(Function<T> value)` Returns a step condition checking if the node value is not equal to the given field value.
`StepCondition`	`notEq(java.util.function.Supplier<T> supplier)` Deprecated. use `notEq(Object)` or `notEq(Function)` instead
`StepCondition`	`notEq(T value)` Returns a step condition checking if the node value is not equal to the given value.
`IntegerFunction`	`position()` Returns a integer function encapsulating the position of this encapsulated field.
`java.lang.String`	`readable()` Returns the human readable version of this object.
`IterableFunction<TagId,java.util.List<TagId>>`	`tags()` Returns a iterable function encapsulating the tags of this encapsulated field.
`java.util.Optional<T>`	`value(FieldModel model, Context context)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.doov.core.dsl.field.types.Function
metadata, read, validate

Methods inherited from interface io.doov.core.dsl.lang.DSLBuilder
isUsing, markdown, markdown, readable

- Field Detail
  - metadata
```
protected final M extends Metadata metadata
```
  - function
```
protected final java.util.function.BiFunction<FieldModel,Context,java.util.Optional<T>> function
```
- Constructor Detail
  - DefaultFunction
```
public DefaultFunction(M metadata,
                       java.util.function.BiFunction<FieldModel,Context,java.util.Optional<T>> function)
```
- Method Detail
  - value
```
public java.util.Optional<T> value(FieldModel model,
                                   Context context)
```
    Specified by:
    
    value in interface ContextAccessor<T>
  - getMetadata
```
public M getMetadata()
```
    Specified by:
    
    getMetadata in interface Function<T>
  - getFunction
```
public java.util.function.BiFunction<FieldModel,Context,java.util.Optional<T>> getFunction()
```
  - readable
```
public java.lang.String readable()
```
    Description copied from interface: Readable
    
    Returns the human readable version of this object.
    
    Specified by:
    
    readable in interface DSLBuilder
    
    Specified by:
    
    readable in interface Readable
    
    Returns:
    
    the readable string
  - tags
```
public final IterableFunction<TagId,java.util.List<TagId>> tags()
```
    Returns a iterable function encapsulating the tags of this encapsulated field.
    
    Returns:
    
    the iterable function
  - position
```
public final IntegerFunction position()
```
    Returns a integer function encapsulating the position of this encapsulated field.
    
    Returns:
    
    the integer function
  - isNull
```
public final StepCondition isNull()
```
    Returns a step condition checking if the node value is null.
    
    Returns:
    
    the step condition
  - isNotNull
```
public final StepCondition isNotNull()
```
    Returns a step condition checking if the node value is not null.
    
    Returns:
    
    the step condition
  - eq
```
public final StepCondition eq(T value)
```
    Returns a step condition checking if the node value is equal to the given value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - eq
```
@Deprecated
public final StepCondition eq(java.util.function.Supplier<T> supplier)
```
    Deprecated. use eq(Object) or eq(Function) instead
    
    Returns a step condition checking if the node value is equal to the given field value.
    
    Parameters:
    
    supplier - the right side value
    
    Returns:
    
    the step condition
  - eq
```
public final StepCondition eq(BaseFieldInfo<T> value)
```
    Returns a step condition checking if the node value is equal to the given supplier value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - eq
```
public final StepCondition eq(Function<T> value)
```
    Returns a step condition checking if the node value is equal to the given supplier value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - notEq
```
public final StepCondition notEq(T value)
```
    Returns a step condition checking if the node value is not equal to the given value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - notEq
```
@Deprecated
public final StepCondition notEq(java.util.function.Supplier<T> supplier)
```
    Deprecated. use notEq(Object) or notEq(Function) instead
    
    Returns a step condition checking if the node value is not equal to the given supplier value.
    
    Parameters:
    
    supplier - the right side value
    
    Returns:
    
    the step condition
  - notEq
```
public final StepCondition notEq(BaseFieldInfo<T> value)
```
    Returns a step condition checking if the node value is not equal to the given field value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - notEq
```
public final StepCondition notEq(Function<T> value)
```
    Returns a step condition checking if the node value is not equal to the given field value.
    
    Parameters:
    
    value - the right side value
    
    Returns:
    
    the step condition
  - anyMatch
```
@SafeVarargs
public final StepCondition anyMatch(T... values)
```
    Returns a step condition checking if the node value matches any of the given values.
    
    Parameters:
    
    values - the values to match
    
    Returns:
    
    the step condition
  - anyMatch
```
public final StepCondition anyMatch(java.util.Collection<T> values)
```
    Returns a step condition checking if the node value matches any of the given values.
    
    Parameters:
    
    values - the values to match
    
    Returns:
    
    the step condition
  - anyMatch
```
public final StepCondition anyMatch(java.util.List<java.util.function.Predicate<T>> values,
                                    java.lang.String... predicateReadables)
```
    Returns a step condition checking if any of the given predicates testing the node value match.
    
    Parameters:
    
    values - the values to match
    
    predicateReadables - strings defining predicates in order
    
    Returns:
    
    the step condition
  - allMatch
```
@SafeVarargs
public final StepCondition allMatch(T... values)
```
    Returns a step condition checking if the node value matches all of the given values.
    
    Parameters:
    
    values - the values to match
    
    Returns:
    
    the step condition
  - allMatch
```
public final StepCondition allMatch(java.util.Collection<T> values)
```
    Returns a step condition checking if the node value matches all of the given values.
    
    Parameters:
    
    values - the values to match
    
    Returns:
    
    the step condition
  - allMatch
```
public final StepCondition allMatch(java.util.List<java.util.function.Predicate<T>> values,
                                    java.lang.String... predicateReadables)
```
    Returns a step condition checking if all of the given predicates testing the node value match.
    
    Parameters:
    
    values - the values to match
    
    predicateReadables - strings defining predicates in order
    
    Returns:
    
    the step condition
  - noneMatch
```
@SafeVarargs
public final StepCondition noneMatch(T... values)
```
    Returns a step condition checking if the node value matches none of the given values.
    
    Parameters:
    
    values - the values to match
    
    Returns:
    
    the step condition
  - noneMatch
```
public final StepCondition noneMatch(java.util.Collection<T> values)
```
    Returns a step condition checking if the node value matches none of the given values.
    
    Parameters:
    
    values - the values to match
    
    Returns:
    
    the step condition
  - noneMatch
```
public final StepCondition noneMatch(java.util.List<java.util.function.Predicate<T>> values,
                                     java.lang.String... predicateReadables)
```
    Returns a step condition checking if none of the given predicates testing the node value match.
    
    Parameters:
    
    values - the values to match
    
    predicateReadables - strings defining predicates in order
    
    Returns:
    
    the step condition
  - mapToInt
```
@Deprecated
public final IntegerFunction mapToInt(java.util.function.Function<T,java.lang.Integer> mapper)
```
    Deprecated. use mapToInt(String, java.util.function.Function) instead
    
    Returns an integer step condition that returns the node value mapped by the given mapper.
    
    Parameters:
    
    mapper - the to integer mapper to apply
    
    Returns:
    
    the integer condition
  - mapToInt
```
public final IntegerFunction mapToInt(java.lang.String readable,
                                      java.util.function.Function<T,java.lang.Integer> mapper)
```
    Returns an integer step condition that returns the node value mapped by the given mapper.
    
    Parameters:
    
    readable - descriptor string for the mapper function
    
    mapper - the to integer mapper to apply
    
    Returns:
    
    the integer condition
  - mapToString
```
@Deprecated
public final StringFunction mapToString(java.util.function.Function<T,java.lang.String> mapper)
```
    Deprecated. use mapToString(String, java.util.function.Function) instead
    
    Returns a string step condition that returns the node value mapped by the given function.
    
    Parameters:
    
    mapper - function to string mapper to apply
    
    Returns:
    
    string condition
  - mapToString
```
public final StringFunction mapToString(java.lang.String readable,
                                        java.util.function.Function<T,java.lang.String> mapper)
```
    Returns a string step condition that returns the node value mapped by the given function.
    
    Parameters:
    
    readable - descriptor string for the mapper function
    
    mapper - function to string mapper to apply
    
    Returns:
    
    string condition
  - map
```
public final <R> DefaultFunction<R,MapFunctionMetadata> map(java.lang.String readable,
                                                            java.util.function.Function<T,R> mapper)
```
    Returns a default step condition that returns the node value mapped by the given function.
    
    Type Parameters:
    
    R - target type
    
    Parameters:
    
    readable - text describing the function
    
    mapper - mapper function to apply
    
    Returns:
    
    condition with target type
  - mapUsing
```
public final <U,R> DefaultFunction<R,MapFunctionMetadata> mapUsing(java.lang.String readable,
                                                                   Function<U> condition,
                                                                   java.util.function.BiFunction<T,U,R> mapper)
```
    Returns an default step condition that returns the node value mapped by the given function.
    
    Type Parameters:
    
    U - condition type
    
    R - target type
    
    Parameters:
    
    readable - description
    
    condition - condition
    
    mapper - mapper function to apply
    
    Returns:
    
    condition with target type

Class DefaultFunction<T,M extends Metadata>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.doov.core.dsl.field.types.Function

Methods inherited from interface io.doov.core.dsl.lang.DSLBuilder

Field Detail

metadata

function

Constructor Detail

DefaultFunction

Method Detail

value

getMetadata

getFunction

readable

tags

position

isNull

isNotNull

eq

eq

eq

eq

notEq

notEq

notEq

notEq

anyMatch

anyMatch

anyMatch

allMatch

allMatch

allMatch

noneMatch

noneMatch

noneMatch

mapToInt

mapToInt

mapToString

mapToString

map

mapUsing