Package org.incendo.cloud.services.type

Interface ConsumerService<Context>

Type Parameters:

Context - Context

All Superinterfaces:

Consumer<Context>, Function<Context,State>, Service<Context,State>, SideEffectService<Context>

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 ConsumerService<Context>
extends SideEffectService<Context>, Consumer<Context>

Service type where each implementation gets a chance to consume the context. This service type effectively turns the pipeline into an event bus.

A service can forcefully terminate execution by calling interrupt()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ConsumerService.PipeBurst

Method Summary

Modifier and Type	Method	Description
void	accept(@NonNull Context context)	Accept the context.
default @NonNull State	handle(@NonNull Context context)	Consumes the context, if possible.
static void	interrupt()	Immediately terminate the execution and return State.ACCEPTED

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.incendo.cloud.services.type.Service

apply, order

Method Details

interrupt

static void interrupt()
               throws ConsumerService.PipeBurst

Immediately terminate the execution and return State.ACCEPTED

Throws:

ConsumerService.PipeBurst - Pipe burst

handle

default @NonNull State handle(@NonNull Context context)

Description copied from interface: SideEffectService

Consumes the context, if possible. Returns State.ACCEPTED if the input was consumed, else State.REJECTED

Specified by:

handle in interface Service<Context,State>

Specified by:

handle in interface SideEffectService<Context>

Parameters:

context - context used in the generation of the response

Returns:

Response. If the response isn't State.ACCEPTED, the next service in the service chain will get to act on the context. Otherwise the execution halts, and the provided response is the final response.

accept

void accept(@NonNull Context context)

Accept the context. Call interrupt() to interrupt the entire pipeline and immediately return State.ACCEPTED to the sink

Specified by:

accept in interface Consumer<Context>

Parameters:

context - Context to consume