com.github.dm.jrt.invocation

Class FunctionInvocation<IN,OUT>

java.lang.Object

com.github.dm.jrt.invocation.TemplateInvocation<IN,OUT>

com.github.dm.jrt.invocation.FunctionInvocation<IN,OUT>

Type Parameters:

IN - the input data type.

OUT - the output data type.

All Implemented Interfaces:

Invocation<IN,OUT>

public abstract class FunctionInvocation<IN,OUT>
extends TemplateInvocation<IN,OUT>

Special abstract implementation that centralizes the routine invocation inside a single method, which gets called only when all the inputs are available.

Created by davide-maestroni on 09/07/2014.

Constructor Summary

Constructors

Constructor and Description
FunctionInvocation()

Method Summary

Methods

Modifier and Type	Method and Description
void	onInput(IN input, ResultChannel<OUT> result) Called when an input is passed to the routine. This method is called once for each input object.
void	onResult(ResultChannel<OUT> result) Called when all the inputs has been passed to the routine. This method is called once in the invocation lifecycle to indicate that the final invocation results should be passed to the result channel.
void	onTerminate() Called when the invocation execution has completed.

Methods inherited from class com.github.dm.jrt.invocation.TemplateInvocation

onAbort, onDestroy, onInitialize

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionInvocation

public FunctionInvocation()

Method Detail

onInput

public final void onInput(IN input,
           @NotNull
           ResultChannel<OUT> result)

Description copied from interface: Invocation

Called when an input is passed to the routine.
This method is called once for each input object.

Specified by:

onInput in interface Invocation<IN,OUT>

Overrides:

onInput in class TemplateInvocation<IN,OUT>

Parameters:

input - the input.

result - the result channel.

onResult

public final void onResult(@NotNull
            ResultChannel<OUT> result)

Description copied from interface: Invocation

Called when all the inputs has been passed to the routine.
This method is called once in the invocation lifecycle to indicate that the final invocation results should be passed to the result channel.

Specified by:

onResult in interface Invocation<IN,OUT>

Overrides:

onResult in class TemplateInvocation<IN,OUT>

Parameters:

result - the result channel.

onTerminate

public final void onTerminate()

Description copied from interface: Invocation

Called when the invocation execution has completed.

Specified by:

onTerminate in interface Invocation<IN,OUT>

Overrides:

onTerminate in class TemplateInvocation<IN,OUT>