io.github.privacystreams.core

Class AsyncFunction<Tin,Tout>

java.lang.Object

io.github.privacystreams.core.Function<Tin,Tout>

io.github.privacystreams.core.AsyncFunction<Tin,Tout>

public abstract class AsyncFunction<Tin,Tout>
extends Function<Tin,Tout>

An AsyncFunction is will be applied in background. When applying this function, the output will immediately return, but the content in output will be generated in background. Subclass must implement: `init` method which initializes the output object and returns in current thread. `applyInBackground` method which produces values to output in background.

Field Summary

Fields

Modifier and Type	Field and Description
protected Tin	input
protected Tout	output

Fields inherited from class io.github.privacystreams.core.Function

isCancelled

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AsyncFunction()

Method Summary

Modifier and Type	Method and Description
Tout	apply(UQI uqi, Tin input) Apply this function
protected abstract void	applyInBackground(UQI uqi, Tin input)
protected UQI	getUQI()
protected abstract Tout	init(UQI uqi, Tin input)
void	onEvent(java.lang.Object obj)

Methods inherited from class io.github.privacystreams.core.Function

addParameters, addRequiredPermissions, cancel, compound, getHead, getParameters, getRequiredPermissions, getTail, onCancel, raiseException, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

input

protected transient Tin input

output

protected transient Tout output

Constructor Detail

AsyncFunction

protected AsyncFunction()

Method Detail

apply

public final Tout apply(UQI uqi,
                        Tin input)

Description copied from class: Function

Apply this function

Specified by:

apply in class Function<Tin,Tout>

Parameters:

uqi - the instance of UQI

input - the function input

Returns:

the function output

onEvent

@Subscribe(threadMode=ASYNC)
public void onEvent(java.lang.Object obj)

getUQI

protected UQI getUQI()

init

protected abstract Tout init(UQI uqi,
                             Tin input)

applyInBackground

protected abstract void applyInBackground(UQI uqi,
                                          Tin input)