io.github.privacystreams.core

Class Function<Tin,Tout>

java.lang.Object

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

Direct Known Subclasses:

AsyncFunction, Callback, EventDrivenFunction, IdleFunction, ItemOperator, ItemsOperator

public abstract class Function<Tin,Tout>
extends java.lang.Object

The abstraction of all function in PrivacyStreams. A Function converts a input in type `Tin` to a output in type `Tout`.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isCancelled

Constructor Summary

Constructors

Constructor and Description
Function() Each Function must initialize requiredPermissions field in constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addParameters(java.lang.Object... parameters)
protected void	addRequiredPermissions(java.lang.String... permissions)
abstract Tout	apply(UQI uqi, Tin input) Apply this function
protected void	cancel(UQI uqi) Cancel this function
<Ttemp> Function<Tin,Ttemp>	compound(Function<Tout,Ttemp> function) Compound this function with another function
Function<Tin,?>	getHead()
protected java.util.List<java.lang.Object>	getParameters()
java.util.Set<java.lang.String>	getRequiredPermissions()
Function<?,Tout>	getTail()
protected void	onCancel(UQI uqi) Callback when this function is cancelled
protected void	raiseException(UQI uqi, PSException psException)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

isCancelled

protected transient volatile boolean isCancelled

Constructor Detail

Function

public Function()

Each Function must initialize requiredPermissions field in constructor.

Method Detail

getRequiredPermissions

public final java.util.Set<java.lang.String> getRequiredPermissions()

getParameters

protected final java.util.List<java.lang.Object> getParameters()

addParameters

protected void addParameters(java.lang.Object... parameters)

addRequiredPermissions

protected void addRequiredPermissions(java.lang.String... permissions)

apply

public abstract Tout apply(UQI uqi,
                           Tin input)

Apply this function

Parameters:

uqi - the instance of UQI

input - the function input

Returns:

the function output

cancel

protected final void cancel(UQI uqi)

Cancel this function

Parameters:

uqi - the instance of UQI

onCancel

protected void onCancel(UQI uqi)

Callback when this function is cancelled

Parameters:

uqi - the instance of UQI

compound

public <Ttemp> Function<Tin,Ttemp> compound(Function<Tout,Ttemp> function)

Compound this function with another function

Type Parameters:

Ttemp - the intermediate variable type between two functions

Parameters:

function - another function

Returns:

the compound function

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getHead

public Function<Tin,?> getHead()

getTail

public Function<?,Tout> getTail()

raiseException

protected final void raiseException(UQI uqi,
                                    PSException psException)