Package tech.illuin.pipeline

Interface Pipeline<I>

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

CompositePipeline

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Pipeline<I>
extends AutoCloseable

The Pipeline interface is both the top-level type for Pipeline implementations, and the entrypoint for the creation of pipeline builders via the of(java.lang.String) methods.

Author:

Pierre Lecerf ([email protected])

Method Summary

Modifier and Type	Method	Description
default Step<?,I>	asStep()
default Step<?,I>	asStep(Function<Output,Result> resultMapper)	Returns a Step wrapping the execution of this Pipeline instance.
default void	close()
default PipelineDescription	describe()
default String	id()	The returned identifier should ideally be unique throughout an application.
default Context	newContext()
default Context	newContext(Output parent)
static <I> SimplePipelineBuilder<I>	of(String id)	Returns a new SimplePipelineBuilder instance for assembling a Pipeline which abstracts away payload management.
static <I> PayloadPipelineBuilder<I>	of(String id, InitializerAssembler<I> initializer)
static <I> PayloadPipelineBuilder<I>	of(String id, Initializer<I> initializer)	Returns a new PayloadPipelineBuilder instance, this is the default type of pipeline with input and payload management.
default Output	run()	Runs the Pipeline with a null input and an empty SimpleContext.
default Output	run(I input)	Runs the Pipeline with an empty SimpleContext.
default Output	run(I input, Consumer<Context> setup)	Runs the Pipeline with a SimpleContext that can be adjusted via the setup argument.
Output	run(I input, Context context)	The run method is the Pipeline's sole entrypoint, responsible for implementing its behaviour.

Method Details

id

default String id()

The returned identifier should ideally be unique throughout an application. It is used in log entries and by the PipelineContainer as an identity and indexing key.

Returns:

the Pipeline's identifier

run

Output run(I input,
 Context context)
    throws PipelineException

The run method is the Pipeline's sole entrypoint, responsible for implementing its behaviour. It returns an Output which is the composition of Result instances produced during the run itself, as well as eventual historical Result retrieved from the Context at initialization.

Parameters:

input - an input value which can be directly processed by Step or can contribute to the initialization of a payload

context - an optional Context instance providing information related tu current and eventual previous runs

Returns:

the Pipeline's output

Throws:

PipelineException

run

default Output run(I input,
 Consumer<Context> setup)
            throws PipelineException

Runs the Pipeline with a SimpleContext that can be adjusted via the setup argument.

Throws:

PipelineException

See Also:

• run(Object, Context)

run

default Output run()
            throws PipelineException

Runs the Pipeline with a null input and an empty SimpleContext.

Throws:

PipelineException

See Also:

• run(Object, Context)

run

default Output run(I input)
            throws PipelineException

Runs the Pipeline with an empty SimpleContext.

Throws:

PipelineException

See Also:

• run(Object, Context)

close

default void close()
            throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

asStep

@Experimental
default Step<?,I> asStep()

See Also:

• asStep(Function)

asStep

@Experimental
default Step<?,I> asStep(Function<Output,Result> resultMapper)

Returns a Step wrapping the execution of this Pipeline instance. The wrapper is responsible for managing context continuity, making it possible for the pipeline to access upstream results.

Parameters:

resultMapper - a mapping function for transforming the pipeline Output into a valid Result

Returns:

a Step instance usable within another Pipeline

of

static <I> SimplePipelineBuilder<I> of(String id)

Returns a new SimplePipelineBuilder instance for assembling a Pipeline which abstracts away payload management.

Type Parameters:

I - the Pipeline's input type

Parameters:

id - the Pipeline's identifier

Returns:

the builder instance

of

static <I> PayloadPipelineBuilder<I> of(String id,
 Initializer<I> initializer)

Returns a new PayloadPipelineBuilder instance, this is the default type of pipeline with input and payload management.

Type Parameters:

I - the Pipeline's input type

Parameters:

id - the Pipeline's identifier

initializer - the Initializer responsible for creating the payload

Returns:

the builder instance

See Also:

• of(String)

of

static <I> PayloadPipelineBuilder<I> of(String id,
 InitializerAssembler<I> initializer)

See Also:

• of(String, Initializer)

newContext

default Context newContext()

newContext

default Context newContext(Output parent)

describe

default PipelineDescription describe()