com.github.dm.jrt.builder

Class TemplateRoutineBuilder<IN,OUT>

java.lang.Object

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

com.github.dm.jrt.builder.TemplateRoutineBuilder<IN,OUT>

Type Parameters:

IN - the input data type.

OUT - the output data type.

All Implemented Interfaces:

ConfigurableBuilder<RoutineBuilder<IN,OUT>>, InvocationConfiguration.Configurable<RoutineBuilder<IN,OUT>>, RoutineBuilder<IN,OUT>, Routine<IN,OUT>

public abstract class TemplateRoutineBuilder<IN,OUT>
extends TemplateRoutine<IN,OUT>
implements RoutineBuilder<IN,OUT>, InvocationConfiguration.Configurable<RoutineBuilder<IN,OUT>>

Empty abstract implementation of a routine builder.

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

Created by davide-maestroni on 03/16/2015.

Constructor Summary

Constructors

Constructor and Description
TemplateRoutineBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
InvocationChannel<IN,OUT>	asyncInvoke() Invokes the execution of this routine in asynchronous mode.
InvocationConfiguration.Builder<? extends RoutineBuilder<IN,OUT>>	invocations() Gets the invocation configuration builder related to the routine builder instance. The configuration options not supported by the routine builder implementation might be ignored.
InvocationChannel<IN,OUT>	parallelInvoke() Invokes the execution of this routine in parallel mode.
RoutineBuilder<IN,OUT>	setConfiguration(InvocationConfiguration configuration) Sets the specified configuration and returns the configurable instance.
InvocationChannel<IN,OUT>	syncInvoke() Invokes the execution of this routine in synchronous mode.

Methods inherited from class com.github.dm.jrt.routine.TemplateRoutine

asyncCall, asyncCall, asyncCall, asyncCall, asyncCall, parallelCall, parallelCall, parallelCall, parallelCall, parallelCall, purge, syncCall, syncCall, syncCall, syncCall, syncCall

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.dm.jrt.builder.RoutineBuilder

buildRoutine

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

asyncCall, asyncCall, asyncCall, asyncCall, asyncCall, parallelCall, parallelCall, parallelCall, parallelCall, parallelCall, purge, syncCall, syncCall, syncCall, syncCall, syncCall

Constructor Detail

TemplateRoutineBuilder

public TemplateRoutineBuilder()

Method Detail

asyncInvoke

@NotNull
public InvocationChannel<IN,OUT> asyncInvoke()

Description copied from interface: Routine

Invokes the execution of this routine in asynchronous mode.

Specified by:

asyncInvoke in interface Routine<IN,OUT>

Returns:

the invocation channel.

parallelInvoke

@NotNull
public InvocationChannel<IN,OUT> parallelInvoke()

Description copied from interface: Routine

Invokes the execution of this routine in parallel mode.

Specified by:

parallelInvoke in interface Routine<IN,OUT>

Returns:

the invocation channel.

syncInvoke

@NotNull
public InvocationChannel<IN,OUT> syncInvoke()

Description copied from interface: Routine

Invokes the execution of this routine in synchronous mode.

Specified by:

syncInvoke in interface Routine<IN,OUT>

Returns:

the invocation channel.

invocations

@NotNull
public InvocationConfiguration.Builder<? extends RoutineBuilder<IN,OUT>> invocations()

Description copied from interface: ConfigurableBuilder

Gets the invocation configuration builder related to the routine builder instance.
The configuration options not supported by the routine builder implementation might be ignored.

Note that the configuration builder will be initialized with the current configuration.

Specified by:

invocations in interface ConfigurableBuilder<RoutineBuilder<IN,OUT>>

Returns:

the invocation configuration builder.

setConfiguration

@NotNull
public RoutineBuilder<IN,OUT> setConfiguration(@NotNull
                                              InvocationConfiguration configuration)

Description copied from interface: InvocationConfiguration.Configurable

Sets the specified configuration and returns the configurable instance.

Specified by:

setConfiguration in interface InvocationConfiguration.Configurable<RoutineBuilder<IN,OUT>>

Parameters:

configuration - the configuration.

Returns:

the configurable instance.