com.github.dm.jrt.android.v11

Class LoaderBuilder

java.lang.Object

com.github.dm.jrt.android.v11.LoaderBuilder

public class LoaderBuilder
extends Object

Context based builder of Loader routine builders.

Created by davide-maestroni on 03/06/2016.

Method Summary

Modifier and Type	Method and Description
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	with(Class<? extends Invocation<IN,OUT>> invocationClass) Returns a routine builder based on an invocation factory creating instances of the specified class.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	with(Class<? extends Invocation<IN,OUT>> invocationClass, Object... args) Returns a routine builder based on an invocation factory creating instances of the specified class by passing the specified arguments to the class constructor.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	with(ClassToken<? extends Invocation<IN,OUT>> invocationToken) Returns a routine builder based on an invocation factory creating instances of the specified class token.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	with(ClassToken<? extends Invocation<IN,OUT>> invocationToken, Object... args) Returns a routine builder based on an invocation factory creating instances of the specified class token by passing the specified arguments to the class constructor.
<OUT> LoaderRoutineBuilder<Void,OUT>	with(CommandInvocation<OUT> invocation) Returns a routine builder based on the specified command invocation.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	with(ContextInvocationFactory<IN,OUT> factory) Returns a builder of routines bound to the builder context.
LoaderObjectProxyRoutineBuilder	with(ContextInvocationTarget<?> target) Returns a builder of routines bound to the builder context, wrapping the specified target object.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	with(Invocation<IN,OUT> invocation) Returns a routine builder based on an invocation factory creating instances of the specified object.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	with(Invocation<IN,OUT> invocation, Object... args) Returns a routine builder based on an invocation factory creating instances of the specified object.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	with(InvocationFactory<IN,OUT> factory) Returns a builder of routines bound to the builder context.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	with(MappingInvocation<IN,OUT> invocation) Returns a routine builder based on the specified mapping invocation.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	withCall(Function<? super List<IN>,? extends OUT> function) Returns a routine builder based on a call invocation factory backed by the specified function.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	withCallConsumer(BiConsumer<? super List<IN>,? super Channel<OUT,?>> consumer) Returns a routine builder based on a call invocation factory backed by the specified consumer.
LoaderObjectProxyRoutineBuilder	withClassOfType(Class<?> targetClass) Returns a builder of routines bound to the builder context, wrapping the specified target class.
<OUT> LoaderRoutineBuilder<Void,OUT>	withCommand(Supplier<? extends OUT> supplier) Returns a routine builder based on a command invocation backed by the specified supplier.
<OUT> LoaderRoutineBuilder<Void,OUT>	withCommandConsumer(Consumer<? super Channel<OUT,?>> consumer) Returns a routine builder based on a command invocation backed by the specified consumer.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	withContextFactory(Supplier<? extends ContextInvocation<? super IN,? extends OUT>> supplier) Returns a routine builder based on an invocation factory backed by the specified supplier.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	withFactory(Supplier<? extends Invocation<? super IN,? extends OUT>> supplier) Returns a routine builder based on an invocation factory backed by the specified supplier.
<IN> LoaderRoutineBuilder<IN,IN>	withFilter(Predicate<? super IN> predicate) Returns a routine builder based on a operation invocation backed by the specified predicate.
LoaderChannelBuilder	withId(int loaderId) Returns a builder of channels bound to the Loader identified by the specified ID.
LoaderObjectProxyRoutineBuilder	withInstanceOf(Class<?> targetClass) Returns a builder of routines bound to the builder context, wrapping the specified target object.
LoaderObjectProxyRoutineBuilder	withInstanceOf(Class<?> targetClass, Object... factoryArgs) Returns a builder of routines bound to the builder context, wrapping the specified target object.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	withMapping(Function<? super IN,? extends OUT> function) Returns a routine builder based on a mapping invocation backed by the specified function.
<IN,OUT> LoaderRoutineBuilder<IN,OUT>	withMappingConsumer(BiConsumer<? super IN,? super Channel<OUT,?>> consumer) Returns a routine builder based on a mapping invocation backed by the specified consumer.

Methods inherited from class java.lang.Object

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

Method Detail

with

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> with(@NotNull
                                                           Class<? extends Invocation<IN,OUT>> invocationClass)

Returns a routine builder based on an invocation factory creating instances of the specified class.
The method accepts also classes implementing ContextInvocation.

Note that inner and anonymous classes can be passed as well. Remember however that Java creates synthetic constructors for such classes, so be sure to specify the correct arguments to guarantee proper instantiation.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

invocationClass - the invocation class.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified invocation has not a static scope or no default construct is found.

with

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> with(@NotNull
                                                           Class<? extends Invocation<IN,OUT>> invocationClass,
                                                           @Nullable
                                                           Object... args)

Returns a routine builder based on an invocation factory creating instances of the specified class by passing the specified arguments to the class constructor.
The method accepts also classes implementing ContextInvocation.

Note that inner and anonymous classes can be passed as well. Remember however that Java creates synthetic constructors for such classes, so be sure to specify the correct arguments to guarantee proper instantiation.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

invocationClass - the invocation class.

args - the invocation constructor arguments.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified invocation has not a static scope or no construct constructor taking the specified objects as parameters is found.

with

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> with(@NotNull
                                                           ClassToken<? extends Invocation<IN,OUT>> invocationToken)

Returns a routine builder based on an invocation factory creating instances of the specified class token.
The method accepts also classes implementing ContextInvocation.

Note that inner and anonymous classes can be passed as well. Remember however that Java creates synthetic constructors for such classes, so be sure to specify the correct arguments to guarantee proper instantiation.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

invocationToken - the invocation class token.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified invocation has not a static scope or no default construct is found.

with

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> with(@NotNull
                                                           ClassToken<? extends Invocation<IN,OUT>> invocationToken,
                                                           @Nullable
                                                           Object... args)

Returns a routine builder based on an invocation factory creating instances of the specified class token by passing the specified arguments to the class constructor.
The method accepts also classes implementing ContextInvocation.

Note that inner and anonymous classes can be passed as well. Remember however that Java creates synthetic constructors for such classes, so be sure to specify the correct arguments to guarantee proper instantiation.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

invocationToken - the invocation class token.

args - the invocation constructor arguments.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified invocation has not a static scope or no construct constructor taking the specified objects as parameters is found.

with

@NotNull
public <OUT> LoaderRoutineBuilder<Void,OUT> with(@NotNull
                                                          CommandInvocation<OUT> invocation)

Returns a routine builder based on the specified command invocation.

Type Parameters:

OUT - the output data type.

Parameters:

invocation - the command invocation instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified invocation has not a static scope.

with

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> with(@NotNull
                                                           MappingInvocation<IN,OUT> invocation)

Returns a routine builder based on the specified mapping invocation.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

invocation - the mapping invocation instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified invocation has not a static scope.

with

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> with(@NotNull
                                                           Invocation<IN,OUT> invocation)

Returns a routine builder based on an invocation factory creating instances of the specified object.
The method accepts also instances implementing ContextInvocation.

Note that inner and anonymous objects can be passed as well. Remember however that Java creates synthetic constructors for such classes, so be sure to specify the correct arguments to guarantee proper instantiation.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

invocation - the invocation instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified invocation has not a static scope or no default construct is found.

with

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> with(@NotNull
                                                           Invocation<IN,OUT> invocation,
                                                           @Nullable
                                                           Object... args)

Returns a routine builder based on an invocation factory creating instances of the specified object.
The method accepts also instances implementing ContextInvocation.

Note that inner and anonymous objects can be passed as well. Remember however that Java creates synthetic constructors for such classes, so be sure to specify the correct arguments to guarantee proper instantiation.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

invocation - the invocation instance.

args - the invocation constructor arguments.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified invocation has not a static scope or no default construct is found.

with

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> with(@NotNull
                                                           ContextInvocationFactory<IN,OUT> factory)

Returns a builder of routines bound to the builder context.
In order to prevent undesired leaks, the class of the specified factory must have a static scope.

Note that the built routine results will be always dispatched on the configured Looper thread, thus waiting for the outputs immediately after its invocation may result in a deadlock.
Note also that the input data passed to the invocation channel will be cached, and the results will be produced only after the invocation channel is closed, so be sure to avoid streaming inputs in order to prevent starvation or out of memory errors.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

factory - the invocation factory.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified factory has not a static scope.

with

@NotNull
public LoaderObjectProxyRoutineBuilder with(@NotNull
                                                     ContextInvocationTarget<?> target)

Returns a builder of routines bound to the builder context, wrapping the specified target object.
In order to customize the object creation, the caller must employ an implementation of a FactoryContext as the application Context.

Note that the built routine results will be always dispatched on the configured Looper thread, thus waiting for the outputs immediately after its invocation may result in a deadlock.

Parameters:

target - the invocation target.

Returns:

the routine builder instance.

with

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> with(@NotNull
                                                           InvocationFactory<IN,OUT> factory)

Returns a builder of routines bound to the builder context.
In order to prevent undesired leaks, the class of the specified factory must have a static scope.

Note that the built routine results will be always dispatched on the configured Looper thread, thus waiting for the outputs immediately after its invocation may result in a deadlock.
Note also that the input data passed to the invocation channel will be cached, and the results will be produced only after the invocation channel is closed, so be sure to avoid streaming inputs in order to prevent starvation or out of memory errors.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

factory - the invocation factory.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified factory has not a static scope.

withCall

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> withCall(@NotNull
                                                               Function<? super List<IN>,? extends OUT> function)

Returns a routine builder based on a call invocation factory backed by the specified function.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

function - the function instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified consumer has not a static scope.

withCallConsumer

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> withCallConsumer(@NotNull
                                                                       BiConsumer<? super List<IN>,? super Channel<OUT,?>> consumer)

Returns a routine builder based on a call invocation factory backed by the specified consumer.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

consumer - the consumer instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified consumer has not a static scope.

withClassOfType

@NotNull
public LoaderObjectProxyRoutineBuilder withClassOfType(@NotNull
                                                                Class<?> targetClass)

Returns a builder of routines bound to the builder context, wrapping the specified target class.
In order to customize the object creation, the caller must employ an implementation of a FactoryContext as the application Context.

Note that the built routine results will be always dispatched on the configured Looper thread, thus waiting for the outputs immediately after its invocation may result in a deadlock.

Parameters:

targetClass - the invocation target class.

Returns:

the routine builder instance.

withCommand

@NotNull
public <OUT> LoaderRoutineBuilder<Void,OUT> withCommand(@NotNull
                                                                 Supplier<? extends OUT> supplier)

Returns a routine builder based on a command invocation backed by the specified supplier.

Type Parameters:

OUT - the output data type.

Parameters:

supplier - the supplier instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified supplier has not a static scope.

withCommandConsumer

@NotNull
public <OUT> LoaderRoutineBuilder<Void,OUT> withCommandConsumer(@NotNull
                                                                         Consumer<? super Channel<OUT,?>> consumer)

Returns a routine builder based on a command invocation backed by the specified consumer.

Type Parameters:

OUT - the output data type.

Parameters:

consumer - the consumer instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified consumer has not a static scope.

withContextFactory

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> withContextFactory(@NotNull
                                                                         Supplier<? extends ContextInvocation<? super IN,? extends OUT>> supplier)

Returns a routine builder based on an invocation factory backed by the specified supplier.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

supplier - the supplier instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified supplier has not a static scope.

withFactory

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> withFactory(@NotNull
                                                                  Supplier<? extends Invocation<? super IN,? extends OUT>> supplier)

Returns a routine builder based on an invocation factory backed by the specified supplier.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

supplier - the supplier instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified supplier has not a static scope.

withFilter

@NotNull
public <IN> LoaderRoutineBuilder<IN,IN> withFilter(@NotNull
                                                            Predicate<? super IN> predicate)

Returns a routine builder based on a operation invocation backed by the specified predicate.

Type Parameters:

IN - the input data type.

Parameters:

predicate - the predicate instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified predicate has not a static scope.

withId

@NotNull
public LoaderChannelBuilder withId(int loaderId)

Returns a builder of channels bound to the Loader identified by the specified ID.
If no invocation with the specified ID is running at the time of the channel creation, the output will be aborted with a MissingLoaderException.

Note that the built routine results will be always dispatched on the configured Looper thread, thus waiting for the outputs immediately after its invocation may result in a deadlock.

Parameters:

loaderId - the Loader ID.

Returns:

the channel builder instance.

withInstanceOf

@NotNull
public LoaderObjectProxyRoutineBuilder withInstanceOf(@NotNull
                                                               Class<?> targetClass)

Returns a builder of routines bound to the builder context, wrapping the specified target object.
In order to customize the object creation, the caller must employ an implementation of a FactoryContext as the application Context.

Note that the built routine results will be always dispatched on the configured Looper thread, thus waiting for the outputs immediately after its invocation may result in a deadlock.

Parameters:

targetClass - the class of the invocation target.

Returns:

the routine builder instance.

withInstanceOf

@NotNull
public LoaderObjectProxyRoutineBuilder withInstanceOf(@NotNull
                                                               Class<?> targetClass,
                                                               @Nullable
                                                               Object... factoryArgs)

Returns a builder of routines bound to the builder context, wrapping the specified target object.
In order to customize the object creation, the caller must employ an implementation of a FactoryContext as the application Context.

Note that the built routine results will be always dispatched on the configured Looper thread, thus waiting for the outputs immediately after its invocation may result in a deadlock.

Parameters:

targetClass - the class of the invocation target.

factoryArgs - the object factory arguments.

Returns:

the routine builder instance.

withMapping

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> withMapping(@NotNull
                                                                  Function<? super IN,? extends OUT> function)

Returns a routine builder based on a mapping invocation backed by the specified function.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

function - the function instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified function has not a static scope.

withMappingConsumer

@NotNull
public <IN,OUT> LoaderRoutineBuilder<IN,OUT> withMappingConsumer(@NotNull
                                                                          BiConsumer<? super IN,? super Channel<OUT,?>> consumer)

Returns a routine builder based on a mapping invocation backed by the specified consumer.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

consumer - the consumer instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified consumer has not a static scope.