io.github.privacystreams.core

Class Callback<Tin>

java.lang.Object

io.github.privacystreams.core.Function<Tin,java.lang.Void>

io.github.privacystreams.core.Callback<Tin>

public abstract class Callback<Tin>
extends Function<Tin,java.lang.Void>

This function is mainly used to handle a result as a callback. Subclasses must implement `onInput` method to handle the result. To handle the exceptions, subclasses should implement `onFail` method.

Field Summary

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

isCancelled

Constructor Summary

Constructors

Constructor and Description
Callback()

Method Summary

Modifier and Type	Method and Description
java.lang.Void	apply(UQI uqi, Tin input) Apply this function
void	onCancel(UQI uqi) Callback when this function is cancelled
protected void	onFail(PSException exception) This method will be invoked if failed to get the result.
protected abstract void	onInput(Tin input) This method will be invoked on received an input.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Callback

public Callback()

Method Detail

apply

public final java.lang.Void apply(UQI uqi,
                                  Tin input)

Description copied from class: Function

Apply this function

Specified by:

apply in class Function<Tin,java.lang.Void>

Parameters:

uqi - the instance of UQI

input - the function input

Returns:

the function output

onCancel

public final void onCancel(UQI uqi)

Description copied from class: Function

Callback when this function is cancelled

Overrides:

onCancel in class Function<Tin,java.lang.Void>

Parameters:

uqi - the instance of UQI

onInput

protected abstract void onInput(Tin input)

This method will be invoked on received an input.

Parameters:

input - the result

onFail

protected void onFail(PSException exception)

This method will be invoked if failed to get the result.

Parameters:

exception - the exception happened during getting the result.