com.github.dm.jrt.invocation

Class CommandInvocation<OUT>

java.lang.Object

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

com.github.dm.jrt.invocation.CommandInvocation<OUT>

Type Parameters:

OUT - the output data type.

All Implemented Interfaces:

Invocation<Void,OUT>

public abstract class CommandInvocation<OUT>
extends InvocationFactory<Void,OUT>
implements Invocation<Void,OUT>

Abstract implementation of an invocation performing a command (that is, no input is required) eventually returning output data.

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

Created by davide-maestroni on 06/05/2015.

Constructor Summary

Constructors

Constructor and Description
CommandInvocation()

Method Summary

Methods

Modifier and Type	Method and Description
Invocation<Void,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	onInput(Void input, ResultChannel<OUT> result) Called when an input is passed to the routine. This method is called once for each input object.
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

onResult

Constructor Detail

CommandInvocation

public CommandInvocation()

Method Detail

newInvocation

@NotNull
public final Invocation<Void,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<Void,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<Void,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<Void,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<Void,OUT>

onInput

public final void onInput(Void 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<Void,OUT>

Parameters:

input - the input.

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<Void,OUT>