com.fluxtion.ext.declarative.api

Interface Wrapper<T>

Type Parameters:

T -

All Known Subinterfaces:

EventWrapper<T>, FilterWrapper<T>, GroupBy<T>

All Known Implementing Classes:

AbstractFilterWrapper, BooleanEitherFilter, BooleanFilter, BooleanMatchFilter, ElseWrapper, MergingWrapper, NodeWrapper, ReusableEventHandler, StringWrapper

public interface Wrapper<T>

A wrapper class that holds a reference to a node in the SEP. Any node in SEP can be a source of a stream of values.

Stream operations are provided to filter and map the underlying wrapped type.

Author:

Greg Higgins

Field Summary

Fields

Modifier and Type	Field and Description
static LongAdder	counter

Method Summary

Modifier and Type	Method and Description
default Wrapper<T>	alwaysReset(boolean alwaysReset) Reset a stateful node after every execution cycle, without the need for a an external resetNotifier(java.lang.Object).
default <S> Wrapper<T>	console(String prefix, com.fluxtion.api.partition.LambdaReflection.SerializableFunction<T,S>... supplier) dump this node to console, prefixed with the supplied message.Object.toString() will be invoked on the node instance.
T	event() The wrapped node
Class<T>	eventClass() The type of the wrapped node
default FilterWrapper<T>	filter(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<T,Boolean> filter)
default <S> FilterWrapper<T>	filter(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<T,S> supplier, com.fluxtion.api.partition.LambdaReflection.SerializableFunction<S,Boolean> filter)
default Wrapper<T>	forEach(com.fluxtion.api.partition.LambdaReflection.SerializableConsumer<T> consumer) Registers a Consumer to operate on the current node when an event wave is passing through this node.
default Wrapper<T>	forEach(com.fluxtion.api.partition.LambdaReflection.SerializableConsumer<T> consumer, String consumerId)
default Wrapper<T>	id(String id) Set the node id for this node within the generated SEP.
default Wrapper<T>	immediateReset(boolean immediateReset) Controls reset timing policy for stateful nodes.
default <R,S> Wrapper<R>	map(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<S,R> mapper, com.fluxtion.api.partition.LambdaReflection.SerializableFunction<T,S> supplier) Maps a value using the provided mapping function.
default <R> Wrapper<R>	map(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<T,R> mapper) Maps a value using the provided mapping function.
default <R> Wrapper<R>	mapDouble(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<? extends Double,R> mapper) Invokes a mapping function that accepts a Double as an input
default <R> Wrapper<R>	mapInt(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<? extends Integer,R> mapper) Invokes a mapping function that accepts a Integer as an input
default <R> Wrapper<R>	mapLong(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<? extends Long,R> mapper) Invokes a mapping function that accepts a Long as an input
default Wrapper<T>	notiferMerge(Object eventNotifier) Attaches an event notification instance to the current stream node.
default Wrapper<T>	notifierOverride(Object eventNotifier) Attaches an event notification instance to the current stream node, overriding the execution path of the current stream.
default Wrapper<T>	notifyOnChange(boolean notifyOnChange) Controls the notification policy of event notification to child nodes for this stream node.
default Wrapper<T>	publishAndReset(Object notifier) resets the stateful node and publishes the current value.
default <T,R,S extends R> Wrapper<T>	push(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<T,S> supplier, com.fluxtion.api.partition.LambdaReflection.SerializableConsumer<R> mapper) pushes a data item from the current node in the stream to any node.The target node will become part of the same execution graph as the source.
default Wrapper<T>	resetNotifier(Object resetNotifier) Attaches a reset notifier instance to the current stream node.

Field Detail

counter

static final LongAdder counter

Method Detail

event

T event()

The wrapped node

Returns:

the wrapped node

eventClass

Class<T> eventClass()

The type of the wrapped node

Returns:

wrapped node class

filter

default FilterWrapper<T> filter(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<T,Boolean> filter)

filter

default <S> FilterWrapper<T> filter(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<T,S> supplier,
                                    com.fluxtion.api.partition.LambdaReflection.SerializableFunction<S,Boolean> filter)

map

default <R> Wrapper<R> map(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<T,R> mapper)

Maps a value using the provided mapping function. The input is the wrapped instance inside this Wrapper.

Type Parameters:

R - The return type of the mapping function

Parameters:

mapper - the mapping function

Returns:

A wrapped value containing the result of the mapping operation

mapDouble

default <R> Wrapper<R> mapDouble(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<? extends Double,R> mapper)

Invokes a mapping function that accepts a Double as an input

Type Parameters:

R - The return type of the mapping function

Parameters:

mapper - the mapping function

Returns:

A wrapped value containing the result of the mapping operation

mapInt

default <R> Wrapper<R> mapInt(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<? extends Integer,R> mapper)

Invokes a mapping function that accepts a Integer as an input

Type Parameters:

R - The return type of the mapping function

Parameters:

mapper - the mapping function

Returns:

A wrapped value containing the result of the mapping operation

mapLong

default <R> Wrapper<R> mapLong(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<? extends Long,R> mapper)

Invokes a mapping function that accepts a Long as an input

Type Parameters:

R - The return type of the mapping function

Parameters:

mapper - the mapping function

Returns:

A wrapped value containing the result of the mapping operation

map

default <R,S> Wrapper<R> map(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<S,R> mapper,
                             com.fluxtion.api.partition.LambdaReflection.SerializableFunction<T,S> supplier)

Maps a value using the provided mapping function. The input is the return value of the supplier function invoked on the wrapped instance.

Type Parameters:

R - The return type of the mapping function

S - The input type required by the mapping function

Parameters:

mapper - the mapping function

supplier -

Returns:

A wrapped value containing the result of the mapping operation

push

default <T,R,S extends R> Wrapper<T> push(com.fluxtion.api.partition.LambdaReflection.SerializableFunction<T,S> supplier,
                                          com.fluxtion.api.partition.LambdaReflection.SerializableConsumer<R> mapper)

pushes a data item from the current node in the stream to any node.The target node will become part of the same execution graph as the source.

The returned node is the current node in the stream.

Type Parameters:

T -

R -

S -

Parameters:

supplier -

mapper -

Returns:

the com.fluxtion.ext.declarative.api.Wrapper

forEach

default Wrapper<T> forEach(com.fluxtion.api.partition.LambdaReflection.SerializableConsumer<T> consumer)

Registers a Consumer to operate on the current node when an event wave is passing through this node. The consumer can perform any operation on the node including mutations. This node, possibly mutated, is passed as a reference to child nodes. No new nodes are created in the stream as a side-effect of this processing.

Parameters:

consumer - Consumer of this node

Returns:

The current node

forEach

default Wrapper<T> forEach(com.fluxtion.api.partition.LambdaReflection.SerializableConsumer<T> consumer,
                           String consumerId)

console

default <S> Wrapper<T> console(String prefix,
                               com.fluxtion.api.partition.LambdaReflection.SerializableFunction<T,S>... supplier)

dump this node to console, prefixed with the supplied message.Object.toString() will be invoked on the node instance.

Type Parameters:

S -

Parameters:

prefix - String prefix for the console message

supplier -

Returns:

The current node

resetNotifier

default Wrapper<T> resetNotifier(Object resetNotifier)

Attaches a reset notifier instance to the current stream node. If the node is Stateful it may be desirable to reset its state under controlled conditions. When the resetNotifier is on an execution path it will invoke the reset method of this node if it is Stateful

Parameters:

resetNotifier - external notifier

Returns:

notiferMerge

default Wrapper<T> notiferMerge(Object eventNotifier)

Attaches an event notification instance to the current stream node. When the notifier updates all the child nodes of this stream node will be on the execution path and invoked following normal SEP rules. The existing execution path will be unaltered if either the parent wrapped node or the eventNotifier updates then the execution path will progress.

Parameters:

eventNotifier - external event notifier

Returns:

notifierOverride

default Wrapper<T> notifierOverride(Object eventNotifier)

Attaches an event notification instance to the current stream node, overriding the execution path of the current stream. Only when the notifier updates will the child nodes of this stream node be on the execution path.

Parameters:

eventNotifier - external event notifier

Returns:

publishAndReset

default Wrapper<T> publishAndReset(Object notifier)

resets the stateful node and publishes the current value. The reset is after the last child on the execution path is executed, equivalent to immediateReset(boolean) with value of false.

Parameters:

notifier -

Returns:

notifyOnChange

default Wrapper<T> notifyOnChange(boolean notifyOnChange)

Controls the notification policy of event notification to child nodes for this stream node. The default policy is to invoke child nodes when the return of the parent event method is true. NotifyOnChange notifies the child only when the parent node return of the previous cycle is false and this one is true.

This can be useful if a single notification of a breach is required and subsequent continued breaches are swallowed, for example this can prevent logging spamming when combined with filters.

Parameters:

notifyOnChange - false = notify always. true = notify on change only

Returns:

The current node

immediateReset

default Wrapper<T> immediateReset(boolean immediateReset)

Controls reset timing policy for stateful nodes. Stateful nodes are reset with resetNotifier(java.lang.Object) or alwaysReset(boolean). The timing policy has the following behaviour:

• true - the stateful node will be reset before any child nodes are invoked on the execution path
• false: - the stateful node will be reset after the final node on the execution path

Parameters:

immediateReset - reset timing policy

Returns:

alwaysReset

default Wrapper<T> alwaysReset(boolean alwaysReset)

Reset a stateful node after every execution cycle, without the need for a an external resetNotifier(java.lang.Object).

• true - the stateful node will be reset after every execution cycle
• false: - the stateful node will only be reset with resetNotifier(java.lang.Object)

Parameters:

alwaysReset - - reset policy for stateful nodes

Returns:

id

default Wrapper<T> id(String id)

Set the node id for this node within the generated SEP. This is the variable name of the node in a Java SEP. The id must be unique for the SEP.

Parameters:

id - the unique id of the node in the SEP

Returns:

The current node