me.devnatan.inventoryframework.pipeline

Class Pipeline<S>

java.lang.Object

me.devnatan.inventoryframework.pipeline.Pipeline<S>

Type Parameters:

S - Pipeline subject type.

public final class Pipeline<S>
extends java.lang.Object

The pipeline is a structure containing a sequence of functions (blocks/lambdas) that are called one after another, distributed in phases topologically ordered, with the ability to mutate the sequence and to call the remaining functions in the pipeline and then return to current block.

All the functions are blocking, thus the whole pipeline is synchronous. Since pipelines contain blocks of code, they can be nested, effectively creating sub-pipelines.

Pipelines are used in IF as an extension mechanism to plug functionality in at the right place.

See Also:

PipelinePhase

Constructor Summary

Constructors

Constructor and Description
Pipeline(PipelinePhase... phases)

Method Summary

Modifier and Type	Method and Description
void	addPhase(@NotNull PipelinePhase phase)
void	execute(@NotNull PipelinePhase phase, S subject)
void	execute(S subject)
boolean	hasPhase(@NotNull PipelinePhase phase)
void	insertPhaseAfter(@NotNull PipelinePhase reference, @NotNull PipelinePhase phase)
void	insertPhaseBefore(@NotNull PipelinePhase reference, @NotNull PipelinePhase phase)
void	intercept(@NotNull PipelinePhase phase, @NotNull PipelineInterceptor<? extends S> interceptor)
void	removeInterceptor(@NotNull PipelinePhase phase, @NotNull PipelineInterceptor<? extends S> interceptor)

Methods inherited from class java.lang.Object

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

Constructor Detail

Pipeline

public Pipeline(PipelinePhase... phases)

Method Detail

hasPhase

public boolean hasPhase(@NotNull
                        @NotNull PipelinePhase phase)

addPhase

public void addPhase(@NotNull
                     @NotNull PipelinePhase phase)

insertPhaseBefore

public void insertPhaseBefore(@NotNull
                              @NotNull PipelinePhase reference,
                              @NotNull
                              @NotNull PipelinePhase phase)

insertPhaseAfter

public void insertPhaseAfter(@NotNull
                             @NotNull PipelinePhase reference,
                             @NotNull
                             @NotNull PipelinePhase phase)

intercept

public void intercept(@NotNull
                      @NotNull PipelinePhase phase,
                      @NotNull
                      @NotNull PipelineInterceptor<? extends S> interceptor)

removeInterceptor

public void removeInterceptor(@NotNull
                              @NotNull PipelinePhase phase,
                              @NotNull
                              @NotNull PipelineInterceptor<? extends S> interceptor)

execute

public void execute(@Nullable
                    S subject)

execute

@TestOnly
public void execute(@NotNull
                              @NotNull PipelinePhase phase,
                              @Nullable
                              S subject)