com.github.dm.jrt.routine

Class TemplateRoutine<IN,OUT>

java.lang.Object

com.github.dm.jrt.routine.TemplateRoutine<IN,OUT>

Type Parameters:

IN - the input data type.

OUT - the output data type.

All Implemented Interfaces:

Routine<IN,OUT>

Direct Known Subclasses:

AbstractRoutine, TemplateRoutineBuilder

public abstract class TemplateRoutine<IN,OUT>
extends Object
implements Routine<IN,OUT>

Empty abstract implementation of a routine.

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

Created by davide-maestroni on 10/17/2014.

Constructor Summary

Constructors

Constructor and Description
TemplateRoutine()

Method Summary

Methods

Modifier and Type	Method and Description
Channel.OutputChannel<OUT>	asyncCall() Short for asyncInvoke().result().
Channel.OutputChannel<OUT>	asyncCall(Channel.OutputChannel<? extends IN> inputs) Short for asyncInvoke().pass(inputs).result().
Channel.OutputChannel<OUT>	asyncCall(IN... inputs) Short for asyncInvoke().pass(inputs).result().
Channel.OutputChannel<OUT>	asyncCall(IN input) Short for asyncInvoke().pass(input).result().
Channel.OutputChannel<OUT>	asyncCall(Iterable<? extends IN> inputs) Short for asyncInvoke().pass(inputs).result().
Channel.OutputChannel<OUT>	parallelCall() Short for parallelInvoke().result().
Channel.OutputChannel<OUT>	parallelCall(Channel.OutputChannel<? extends IN> inputs) Short for parallelInvoke().pass(inputs).result().
Channel.OutputChannel<OUT>	parallelCall(IN... inputs) Short for parallelInvoke().pass(inputs).result().
Channel.OutputChannel<OUT>	parallelCall(IN input) Short for parallelInvoke().pass(input).result().
Channel.OutputChannel<OUT>	parallelCall(Iterable<? extends IN> inputs) Short for parallelInvoke().pass(inputs).result().
void	purge() Makes the routine destroy all the cached invocation instances.
Channel.OutputChannel<OUT>	syncCall() Short for syncInvoke().result().
Channel.OutputChannel<OUT>	syncCall(Channel.OutputChannel<? extends IN> inputs) Short for syncInvoke().pass(inputs).result().
Channel.OutputChannel<OUT>	syncCall(IN... inputs) Short for syncInvoke().pass(inputs).result().
Channel.OutputChannel<OUT>	syncCall(IN input) Short for syncInvoke().pass(input).result().
Channel.OutputChannel<OUT>	syncCall(Iterable<? extends IN> inputs) Short for syncInvoke().pass(inputs).result().

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.dm.jrt.routine.Routine

asyncInvoke, parallelInvoke, syncInvoke

Constructor Detail

TemplateRoutine

public TemplateRoutine()

Method Detail

asyncCall

@NotNull
public Channel.OutputChannel<OUT> asyncCall()

Description copied from interface: Routine

Short for asyncInvoke().result().

Specified by:

asyncCall in interface Routine<IN,OUT>

Returns:

the output channel.

asyncCall

@NotNull
public Channel.OutputChannel<OUT> asyncCall(@Nullable
                                           IN input)

Description copied from interface: Routine

Short for asyncInvoke().pass(input).result().

Specified by:

asyncCall in interface Routine<IN,OUT>

Parameters:

input - the input.

Returns:

the output channel.

asyncCall

@NotNull
public Channel.OutputChannel<OUT> asyncCall(@Nullable
                                           IN... inputs)

Description copied from interface: Routine

Short for asyncInvoke().pass(inputs).result().

Specified by:

asyncCall in interface Routine<IN,OUT>

Parameters:

inputs - the input data.

Returns:

the output channel.

asyncCall

@NotNull
public Channel.OutputChannel<OUT> asyncCall(@Nullable
                                           Iterable<? extends IN> inputs)

Description copied from interface: Routine

Short for asyncInvoke().pass(inputs).result().

Specified by:

asyncCall in interface Routine<IN,OUT>

Parameters:

inputs - the iterable returning the input data.

Returns:

the output channel.

asyncCall

@NotNull
public Channel.OutputChannel<OUT> asyncCall(@Nullable
                                           Channel.OutputChannel<? extends IN> inputs)

Description copied from interface: Routine

Short for asyncInvoke().pass(inputs).result().

Specified by:

asyncCall in interface Routine<IN,OUT>

Parameters:

inputs - the output channel returning the input data.

Returns:

the output channel.

parallelCall

@NotNull
public Channel.OutputChannel<OUT> parallelCall()

Description copied from interface: Routine

Short for parallelInvoke().result().

(This method actually makes little sense, and should never need to be called, thought it is here for completeness)

Specified by:

parallelCall in interface Routine<IN,OUT>

Returns:

the output channel.

parallelCall

@NotNull
public Channel.OutputChannel<OUT> parallelCall(@Nullable
                                              IN input)

Description copied from interface: Routine

Short for parallelInvoke().pass(input).result().

(This method actually makes little sense, and should never need to be called, thought it is here for completeness)

Specified by:

parallelCall in interface Routine<IN,OUT>

Parameters:

input - the input.

Returns:

the output channel.

parallelCall

@NotNull
public Channel.OutputChannel<OUT> parallelCall(@Nullable
                                              IN... inputs)

Description copied from interface: Routine

Short for parallelInvoke().pass(inputs).result().

Specified by:

parallelCall in interface Routine<IN,OUT>

Parameters:

inputs - the input data.

Returns:

the output channel.

parallelCall

@NotNull
public Channel.OutputChannel<OUT> parallelCall(@Nullable
                                              Iterable<? extends IN> inputs)

Description copied from interface: Routine

Short for parallelInvoke().pass(inputs).result().

Specified by:

parallelCall in interface Routine<IN,OUT>

Parameters:

inputs - the iterable returning the input data.

Returns:

the output channel.

parallelCall

@NotNull
public Channel.OutputChannel<OUT> parallelCall(@Nullable
                                              Channel.OutputChannel<? extends IN> inputs)

Description copied from interface: Routine

Short for parallelInvoke().pass(inputs).result().

Specified by:

parallelCall in interface Routine<IN,OUT>

Parameters:

inputs - the output channel returning the input data.

Returns:

the output channel.

purge

public void purge()

Description copied from interface: Routine

Makes the routine destroy all the cached invocation instances.

This method is useful to force the release of external resources when done with the routine. Note however that the routine will still be usable after the method returns.

Normally it is not needed to call this method.

Specified by:

purge in interface Routine<IN,OUT>

syncCall

@NotNull
public Channel.OutputChannel<OUT> syncCall()

Description copied from interface: Routine

Short for syncInvoke().result().

Specified by:

syncCall in interface Routine<IN,OUT>

Returns:

the output channel.

syncCall

@NotNull
public Channel.OutputChannel<OUT> syncCall(@Nullable
                                          IN input)

Description copied from interface: Routine

Short for syncInvoke().pass(input).result().

Specified by:

syncCall in interface Routine<IN,OUT>

Parameters:

input - the input.

Returns:

the output channel.

syncCall

@NotNull
public Channel.OutputChannel<OUT> syncCall(@Nullable
                                          IN... inputs)

Description copied from interface: Routine

Short for syncInvoke().pass(inputs).result().

Specified by:

syncCall in interface Routine<IN,OUT>

Parameters:

inputs - the input data.

Returns:

the output channel.

syncCall

@NotNull
public Channel.OutputChannel<OUT> syncCall(@Nullable
                                          Iterable<? extends IN> inputs)

Description copied from interface: Routine

Short for syncInvoke().pass(inputs).result().

Specified by:

syncCall in interface Routine<IN,OUT>

Parameters:

inputs - the iterable returning the input data.

Returns:

the output channel.

syncCall

@NotNull
public Channel.OutputChannel<OUT> syncCall(@Nullable
                                          Channel.OutputChannel<? extends IN> inputs)

Description copied from interface: Routine

Short for syncInvoke().pass(inputs).result().

Specified by:

syncCall in interface Routine<IN,OUT>

Parameters:

inputs - the output channel returning the input data.

Returns:

the output channel.