org.osgl

Class Osgl.F2<P1,P2,R>

java.lang.Object

org.osgl.Osgl.FuncBase

org.osgl.Osgl.F2<P1,P2,R>

All Implemented Interfaces:

Osgl.Func2<P1,P2,R>

Direct Known Subclasses:

N.RangeStep, Osgl.Comparator, Osgl.IndexedVisitor, Osgl.V2, SimpleStringValueResolver

Enclosing class:

Osgl

public abstract static class Osgl.F2<P1,P2,R>
extends Osgl.FuncBase
implements Osgl.Func2<P1,P2,R>

Base implementation of Osgl.Func2 function. User application should (nearly) always make their implementation extend to this base class instead of implement Osgl.Func2 directly

Since:

0.2

Constructor Summary

Constructors

Constructor and Description
F2()

Method Summary

Modifier and Type	Method and Description
Osgl.F2<P1,P2,R>	andThen(Osgl.Func2<? super P1,? super P2,? extends R>... fs) Returns a composed function that applied, in sequence, this function and all functions specified one by one.
<T> Osgl.F2<P1,P2,T>	andThen(Osgl.Function<? super R,? extends T> f) Returns a composed function from this function and the specified function that takes the result of this function.
R	applyOrElse(P1 p1, P2 p2, Osgl.F2<? super P1,? super P2,? extends R> fallback) Applies this partial function to the given argument when it is contained in the function domain.
Osgl.F0<R>	curry(P1 p1, P2 p2)
Osgl.F1<P1,R>	curry(P2 p2)
Osgl.F2<P1,P2,Osgl.Option<R>>	lift() Turns this partial function into a plain function returning an Option result.
Osgl.F2<P1,P2,R>	orElse(Osgl.Func2<? super P1,? super P2,? extends R> fallback) Returns a composed function that when applied, try to apply this function first, in case a NotAppliedException is captured apply to the fallback function specified.

Methods inherited from class org.osgl.Osgl.FuncBase

breakOut

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.osgl.Osgl.Func2

apply

Constructor Detail

F2

public F2()

Method Detail

applyOrElse

public R applyOrElse(P1 p1,
                     P2 p2,
                     Osgl.F2<? super P1,? super P2,? extends R> fallback)

Applies this partial function to the given argument when it is contained in the function domain. Applies fallback function where this partial function is not defined.

Parameters:

p1 - the first param with type P1

p2 - the second param with type P2

fallback - the function to be called when an RuntimeException caught

Returns:

the result of this function or the fallback function application

curry

public final Osgl.F0<R> curry(P1 p1,
                              P2 p2)

curry

public final Osgl.F1<P1,R> curry(P2 p2)

andThen

public <T> Osgl.F2<P1,P2,T> andThen(Osgl.Function<? super R,? extends T> f)

Returns a composed function from this function and the specified function that takes the result of this function. When applying the composed function, this function is applied first to given parameter and then the specified function is applied to the result of this function.

Type Parameters:

T - the return type of function f

Parameters:

f - the function takes the R type parameter and return T type result

Returns:

the composed function

Throws:

NullPointerException - if f is null

andThen

public Osgl.F2<P1,P2,R> andThen(Osgl.Func2<? super P1,? super P2,? extends R>... fs)

Returns a composed function that applied, in sequence, this function and all functions specified one by one. If applying anyone of the functions throws an exception, it is relayed to the caller of the composed function. If an exception is thrown out, the following functions will not be applied.

When apply the composed function, the result of the last function is returned

Parameters:

fs - a sequence of function to be applied after this function

Returns:

a composed function

orElse

public Osgl.F2<P1,P2,R> orElse(Osgl.Func2<? super P1,? super P2,? extends R> fallback)

Returns a composed function that when applied, try to apply this function first, in case a NotAppliedException is captured apply to the fallback function specified. This method helps to implement partial function

Parameters:

fallback - the function to applied if this function doesn't apply to the parameter(s)

Returns:

the composed function

lift

public Osgl.F2<P1,P2,Osgl.Option<R>> lift()

Turns this partial function into a plain function returning an Option result.

Returns:

a function that takes an argument x to Some(this.apply(x)) if this can be applied, and to None otherwise.