com.github.dm.jrt.android.v4

Class JRoutineAndroidCompat

java.lang.Object

com.github.dm.jrt.channel.Channels

com.github.dm.jrt.android.channel.AndroidChannels

com.github.dm.jrt.android.v4.channel.SparseChannelsCompat

com.github.dm.jrt.android.v4.JRoutineAndroidCompat

public class JRoutineAndroidCompat
extends SparseChannelsCompat

Class acting as a façade of all the JRoutine library features, with support for the Android compatibility library.

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

Method Summary

Modifier and Type	Method and Description
static ChannelBuilder	io() Returns a channel builder.
static ServiceBuilder	on(Context context) Returns a Context based builder of Service routine builders.
static ServiceBuilder	on(Context context, Class<? extends InvocationService> serviceClass) Returns a Context based builder of Service routine builders.
static ServiceBuilder	on(Context context, Intent service) Returns a Context based builder of Service routine builders.
static LoaderBuilderCompat	on(Fragment fragment) Returns a Context based builder of Loader routine builders.
static LoaderBuilderCompat	on(FragmentActivity activity) Returns a Context based builder of Loader routine builders.
static LoaderBuilderCompat	on(FragmentActivity activity, Context context) Returns a Context based builder of Loader routine builders.
static LoaderBuilderCompat	on(Fragment fragment, Context context) Returns a Context based builder of Loader routine builders.
static LoaderBuilderCompat	on(LoaderContextCompat context) Returns a Context based builder of Loader routine builders.
static ServiceBuilder	on(ServiceContext context) Returns a Context based builder of Service routine builders.
static <IN> LoaderStreamBuilderCompat<IN,IN>	withStream() Returns a stream routine builder.
static <IN> LoaderStreamBuilderCompat<IN,IN>	withStreamAccept(Consumer<Channel<IN,?>> consumer) Returns a stream routine builder producing only the inputs passed by the specified consumer.
static <IN> LoaderStreamBuilderCompat<IN,IN>	withStreamAccept(int count, Consumer<Channel<IN,?>> consumer) Returns a stream routine builder producing only the inputs passed by the specified consumer.
static <IN> LoaderStreamBuilderCompat<IN,IN>	withStreamGet(int count, Supplier<IN> supplier) Returns a stream routine builder producing only the inputs returned by the specified supplier.
static <IN> LoaderStreamBuilderCompat<IN,IN>	withStreamGet(Supplier<IN> supplier) Returns a stream routine builder producing only the inputs returned by the specified supplier.
static <IN> LoaderStreamBuilderCompat<IN,IN>	withStreamOf(Channel<?,? extends IN> channel) Returns a stream routine builder producing only the inputs returned by the specified channel.
static <IN> LoaderStreamBuilderCompat<IN,IN>	withStreamOf(IN... inputs) Returns a stream routine builder producing only the specified inputs.
static <IN> LoaderStreamBuilderCompat<IN,IN>	withStreamOf(IN input) Returns a stream routine builder producing only the specified input.
static <IN> LoaderStreamBuilderCompat<IN,IN>	withStreamOf(Iterable<? extends IN> inputs) Returns a stream routine builder producing only the inputs returned by the specified iterable.

Methods inherited from class com.github.dm.jrt.android.v4.channel.SparseChannelsCompat

combine, mergeParcelable, selectInputParcelable, selectInputParcelable, selectInputParcelable, selectOutputParcelable, selectOutputParcelable, selectOutputParcelable

Methods inherited from class com.github.dm.jrt.android.channel.AndroidChannels

mergeParcelable, mergeParcelable, mergeParcelable, mergeParcelable, parcelableByteChannel, parcelableByteChannel, parcelableByteChannel, selectableOutputParcelable, selectInputParcelable

Methods inherited from class com.github.dm.jrt.channel.Channels

blend, blend, byteChannel, byteChannel, byteChannel, combine, combine, combine, combine, combine, concat, concat, distribute, distribute, distribute, distribute, fromFuture, fromFutureInterruptIfRunning, join, join, join, join, merge, merge, merge, merge, merge, replay, selectableInput, selectableOutput, selectInput, selectInput, selectInput, selectInput, selectOutput, selectOutput, selectOutput

Methods inherited from class java.lang.Object

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

Method Detail

io

@NotNull
public static ChannelBuilder io()

Returns a channel builder.

Returns:

the channel builder instance.

on

@NotNull
public static ServiceBuilder on(@NotNull
                                         Context context)

Returns a Context based builder of Service routine builders.

Parameters:

context - the Service Context.

Returns:

the Context based builder.

on

@NotNull
public static ServiceBuilder on(@NotNull
                                         Context context,
                                         @NotNull
                                         Class<? extends InvocationService> serviceClass)

Returns a Context based builder of Service routine builders.

Parameters:

context - the Service Context.

serviceClass - the Service class.

Returns:

the Context based builder.

on

@NotNull
public static ServiceBuilder on(@NotNull
                                         Context context,
                                         @NotNull
                                         Intent service)

Returns a Context based builder of Service routine builders.

Parameters:

context - the Service Context.

service - the Service Intent.

Returns:

the Context based builder.

on

@NotNull
public static LoaderBuilderCompat on(@NotNull
                                              Fragment fragment)

Returns a Context based builder of Loader routine builders.

Parameters:

fragment - the Loader Fragment.

Returns:

the Context based builder.

on

@NotNull
public static LoaderBuilderCompat on(@NotNull
                                              Fragment fragment,
                                              @NotNull
                                              Context context)

Returns a Context based builder of Loader routine builders.

Parameters:

fragment - the Loader Fragment.

context - the Context used to get the application one.

Returns:

the Context based builder.

on

@NotNull
public static LoaderBuilderCompat on(@NotNull
                                              FragmentActivity activity)

Returns a Context based builder of Loader routine builders.

Parameters:

activity - the Loader Activity.

Returns:

the Context based builder.

on

@NotNull
public static LoaderBuilderCompat on(@NotNull
                                              FragmentActivity activity,
                                              @NotNull
                                              Context context)

Returns a Context based builder of Loader routine builders.

Parameters:

activity - the Loader Activity.

context - the Context used to get the application one.

Returns:

the Context based builder.

on

@NotNull
public static LoaderBuilderCompat on(@NotNull
                                              LoaderContextCompat context)

Returns a Context based builder of Loader routine builders.

Parameters:

context - the Loader context.

Returns:

the Context based builder.

on

@NotNull
public static ServiceBuilder on(@NotNull
                                         ServiceContext context)

Returns a Context based builder of Service routine builders.

Parameters:

context - the Service context.

Returns:

the Context based builder.

withStream

@NotNull
public static <IN> LoaderStreamBuilderCompat<IN,IN> withStream()

Returns a stream routine builder.

Type Parameters:

IN - the input data type.

Returns:

the routine builder instance.

withStreamAccept

@NotNull
public static <IN> LoaderStreamBuilderCompat<IN,IN> withStreamAccept(@NotNull
                                                                              Consumer<Channel<IN,?>> consumer)

Returns a stream routine builder producing only the inputs passed by the specified consumer.
The data will be produced only when the invocation completes.
If any other input is passed to the built routine, the invocation will be aborted with an IllegalStateException.

Type Parameters:

IN - the input 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.

withStreamAccept

@NotNull
public static <IN> LoaderStreamBuilderCompat<IN,IN> withStreamAccept(int count,
                                                                              @NotNull
                                                                              Consumer<Channel<IN,?>> consumer)

Returns a stream routine builder producing only the inputs passed by the specified consumer.
The data will be produced by calling the consumer count number of times only when the invocation completes.
If any other input is passed to the built routine, the invocation will be aborted with an IllegalStateException.

Type Parameters:

IN - the input data type.

Parameters:

count - the number of times the consumer is called.

consumer - the consumer instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified consumer has not a static scope or the specified count number is 0 or negative.

withStreamGet

@NotNull
public static <IN> LoaderStreamBuilderCompat<IN,IN> withStreamGet(@NotNull
                                                                           Supplier<IN> supplier)

Returns a stream routine builder producing only the inputs returned by the specified supplier.
The data will be produced only when the invocation completes.
If any other input is passed to the built routine, the invocation will be aborted with an IllegalStateException.

Type Parameters:

IN - the input 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.

withStreamGet

@NotNull
public static <IN> LoaderStreamBuilderCompat<IN,IN> withStreamGet(int count,
                                                                           @NotNull
                                                                           Supplier<IN> supplier)

Returns a stream routine builder producing only the inputs returned by the specified supplier.
The data will be produced by calling the supplier count number of times only when the invocation completes.
If any other input is passed to the built routine, the invocation will be aborted with an IllegalStateException.

Type Parameters:

IN - the input data type.

Parameters:

count - the number of times the supplier is called.

supplier - the supplier instance.

Returns:

the routine builder instance.

Throws:

IllegalArgumentException - if the class of the specified supplier has not a static scope or the specified count number is 0 or negative.

withStreamOf

@NotNull
public static <IN> LoaderStreamBuilderCompat<IN,IN> withStreamOf(@Nullable
                                                                          IN input)

Returns a stream routine builder producing only the specified input.
The data will be produced only when the invocation completes.
If any other input is passed to the built routine, the invocation will be aborted with an IllegalStateException.

Type Parameters:

IN - the input data type.

Parameters:

input - the input.

Returns:

the routine builder instance.

withStreamOf

@NotNull
public static <IN> LoaderStreamBuilderCompat<IN,IN> withStreamOf(@Nullable
                                                                          IN... inputs)

Returns a stream routine builder producing only the specified inputs.
The data will be produced only when the invocation completes.
If any other input is passed to the built routine, the invocation will be aborted with an IllegalStateException.

Type Parameters:

IN - the input data type.

Parameters:

inputs - the input data.

Returns:

the routine builder instance.

withStreamOf

@NotNull
public static <IN> LoaderStreamBuilderCompat<IN,IN> withStreamOf(@Nullable
                                                                          Iterable<? extends IN> inputs)

Returns a stream routine builder producing only the inputs returned by the specified iterable.
The data will be produced only when the invocation completes.
If any other input is passed to the built routine, the invocation will be aborted with an IllegalStateException.

Type Parameters:

IN - the input data type.

Parameters:

inputs - the inputs iterable.

Returns:

the routine builder instance.

withStreamOf

@NotNull
public static <IN> LoaderStreamBuilderCompat<IN,IN> withStreamOf(@Nullable
                                                                          Channel<?,? extends IN> channel)

Returns a stream routine builder producing only the inputs returned by the specified channel.
The data will be produced only when the invocation completes.
If any other input is passed to the built routine, the invocation will be aborted with an IllegalStateException.

Note that the passed channel will be bound as a result of the call, so, in order to support multiple invocations, consider wrapping the channel in a replayable one, by calling the Channels.replay(Channel) utility method.

Type Parameters:

IN - the input data type.

Parameters:

channel - the input channel.

Returns:

the routine builder instance.