com.github.dm.jrt.invocation

Class TemplateInvocation<IN,OUT>

java.lang.Object

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

Type Parameters:

IN - the input data type.

OUT - the output data type.

All Implemented Interfaces:

Invocation<IN,OUT>

Direct Known Subclasses:

FunctionInvocation

public abstract class TemplateInvocation<IN,OUT>
extends Object
implements Invocation<IN,OUT>

Empty abstract implementation of a routine invocation.

This class is useful to avoid the need of implementing all the methods defined in the interface.

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

Constructor Summary

Constructors

Constructor and Description
TemplateInvocation()

Method Summary

Methods

Modifier and Type	Method and Description
void	onAbort(RoutineException reason) Called when the routine execution is aborted. This method may be called at any time after the invocation initialization.
void	onDestroy() Called when the routine invocation is no longer needed.
void	onInitialize() Called when the routine invocation is initialized. This is always the first method in the invocation lifecycle.
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 java.lang.Object

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

Constructor Detail

TemplateInvocation

public TemplateInvocation()

Method Detail

onAbort

public void onAbort(@Nullable
           RoutineException reason)

Description copied from interface: Invocation

Called when the routine execution is aborted.
This method may be called at any time after the invocation initialization.

Specified by:

onAbort in interface Invocation<IN,OUT>

Parameters:

reason - the reason of the abortion.

onDestroy

public void onDestroy()

Description copied from interface: Invocation

Called when the routine invocation is no longer needed.

Specified by:

onDestroy in interface Invocation<IN,OUT>

onInitialize

public void onInitialize()

Description copied from interface: Invocation

Called when the routine invocation is initialized.
This is always the first method in the invocation lifecycle.

Specified by:

onInitialize in interface Invocation<IN,OUT>

onInput

public 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>

Parameters:

input - the input.

result - the result channel.

onResult

public 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>

Parameters:

result - the result channel.

onTerminate

public void onTerminate()

Description copied from interface: Invocation

Called when the invocation execution has completed.

Specified by:

onTerminate in interface Invocation<IN,OUT>