com.github.dm.jrt.invocation

Class FilterInvocation<IN,OUT>

java.lang.Object

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

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

Type Parameters:

IN - the input data type.

OUT - the output data type.

All Implemented Interfaces:

Invocation<IN,OUT>

Direct Known Subclasses:

PassingInvocation

public abstract class FilterInvocation<IN,OUT>
extends InvocationFactory<IN,OUT>
implements Invocation<IN,OUT>

Abstract implementation of an invocation filtering each input and transforming it in output data.

Note that the implementing class must not retain an internal variable state.

Created by davide-maestroni on 02/14/2015.

Constructor Summary

Constructors

Constructor and Description
FilterInvocation()

Method Summary

Methods

Modifier and Type	Method and Description
Invocation<IN,OUT>	newInvocation() Creates and return a new invocation instance. A proper implementation will return a new invocation instance each time it is called, unless the returned object is immutable and does not cause any side effect. Any behavior other than that may lead to unexpected results.
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	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

Methods inherited from interface com.github.dm.jrt.invocation.Invocation

onInput

Constructor Detail

FilterInvocation

public FilterInvocation()

Method Detail

newInvocation

@NotNull
public final Invocation<IN,OUT> newInvocation()

Description copied from class: InvocationFactory

Creates and return a new invocation instance.
A proper implementation will return a new invocation instance each time it is called, unless the returned object is immutable and does not cause any side effect.
Any behavior other than that may lead to unexpected results.

Specified by:

newInvocation in class InvocationFactory<IN,OUT>

Returns:

the invocation instance.

onAbort

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

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>

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>