org.tools4j.nobark.loop

Interface StepProvider

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 StepProvider

Provider for Step distinguishing between normal (main loop) steps and shutdown steps that are used during the termination phase of a ShutdownableThread as returned by Loop#start(..).

Method Summary

Modifier and Type	Method and Description
static StepProvider	alwaysProvide(Step step) Returns a provider for the given step used for both normal and shutdown phase.
static Step	normalStep(StepProvider supplier) Returns a normal step using the given supplier.
Step	provide(boolean forShutdown) Returns a step for normal or shutdown use.
static Step	shutdownStep(StepProvider supplier) Returns a shutdown step using the given supplier.
static StepProvider	silenceDuringShutdown(Step step) Returns a provider for the given step used only for the normal phase; a no-OP is returned for the shutdown phase.

Method Detail

provide

Step provide(boolean forShutdown)

Returns a step for normal or shutdown use.

Parameters:

forShutdown - true if the returned step will be used in the shutdown phase, and false otherwise

Returns:

the step, never null

normalStep

static Step normalStep(StepProvider supplier)

Returns a normal step using the given supplier.

Parameters:

supplier - the supplier that provides the step

Returns:

a step for use during the normal phase

shutdownStep

static Step shutdownStep(StepProvider supplier)

Returns a shutdown step using the given supplier.

Parameters:

supplier - the supplier that provides the step

Returns:

a step for use during the shutdown phase

alwaysProvide

static StepProvider alwaysProvide(Step step)

Returns a provider for the given step used for both normal and shutdown phase.

Parameters:

step - the step to be returned by the provider

Returns:

a provider that always returns the given step

silenceDuringShutdown

static StepProvider silenceDuringShutdown(Step step)

Returns a provider for the given step used only for the normal phase; a no-OP is returned for the shutdown phase.

Parameters:

step - the step to be returned by the provider for the normal phase

Returns:

a provider that returns the given step for normal phase and a no-OP for the shutdown phase