org.osgl

Class Osgl.F1<P1,R>

java.lang.Object

org.osgl.Osgl.FuncBase

org.osgl.Osgl.F1<P1,R>

All Implemented Interfaces:

Osgl.Bijection<P1,R>, Osgl.Func1<P1,R>, Osgl.Function<P1,R>, Osgl.MultiplicableFunction<P1,R>

Direct Known Subclasses:

Osgl.Operator, Osgl.Predicate, Osgl.Processor, Osgl.Transformer, Osgl.Visitor, SimpleObjectFactory, StringValueResolver

Enclosing class:

Osgl

public abstract static class Osgl.F1<P1,R>
extends Osgl.FuncBase
implements Osgl.Func1<P1,R>, Osgl.Bijection<P1,R>, Osgl.MultiplicableFunction<P1,R>

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

Since:

0.2

Constructor Summary

Constructors

Constructor and Description
F1()

Method Summary

Modifier and Type	Method and Description
Osgl.F1<P1,R>	andThen(Osgl.Function<? super P1,? extends R>... afters) Returns a composed function that applied, in sequence, this function and all functions specified one by one.
<T> Osgl.F1<P1,T>	andThen(Osgl.Function<? super R,? extends T> after) Returns a composed function that applies this function to it's input and then applies the after function to the result.
R	applyOrElse(P1 p1, Osgl.F1<? super P1,? extends R> fallback) Applies this partial function to the given argument when it is contained in the function domain.
Osgl.F0<R>	compose(Osgl.Func0<? extends P1> before) Returns an F0&lt;R&gt;> function by composing the specified Func0&ltP1&gt; function with this function applied last
<X1,X2> Osgl.F2<X1,X2,R>	compose(Osgl.Func2<? super X1,? super X2,? extends P1> before) Returns an F2&lt;X1, X2, R&gt;> function by composing the specified Func2&ltX1, X2, P1&gt; function with this function applied last
<X1,X2,X3> Osgl.F3<X1,X2,X3,R>	compose(Osgl.Func3<? super X1,? super X2,? super X3,? extends P1> before) Returns an F3&lt;X1, X2, X3, R&gt;> function by composing the specified Func3&ltX1, X2, X3, P1&gt; function with this function applied last
<X1,X2,X3,X4> Osgl.F4<X1,X2,X3,X4,R>	compose(Osgl.Func4<? super X1,? super X2,? super X3,? super X4,? extends P1> before) Returns an F3&lt;X1, X2, X3, X4, R&gt;> function by composing the specified Func3&ltX1, X2, X3, X4, P1&gt; function with this function applied last
<X1,X2,X3,X4,X5> Osgl.F5<X1,X2,X3,X4,X5,R>	compose(Osgl.Func5<? super X1,? super X2,? super X3,? super X4,? super X5,? extends P1> before) Returns an F3&lt;X1, X2, X3, X4, X5, R&gt;> function by composing the specified Func3&ltX1, X2, X3, X4, X5, P1&gt; function with this function applied last
<X1> Osgl.F1<X1,R>	compose(Osgl.Function<? super X1,? extends P1> before) Returns an F1&lt;X1, R&gt;> function by composing the specified Function&ltX1, P1&gt; function with this function applied last
Osgl.F0<R>	curry(P1 p1)
Osgl.Bijection<R,P1>	invert() Returns the inverse function mapping from Y back to X
Osgl.F1<P1,Osgl.Option<R>>	lift() Turns this partial function into a plain function returning an Option result.
Osgl.F1<P1,R>	orElse(Osgl.Function<? super P1,? 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.
Osgl.MultiplicableFunction<P1,R>	times(int n) Returns a function with n times factor 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.Function

apply

Constructor Detail

F1

public F1()

Method Detail

invert

public Osgl.Bijection<R,P1> invert()

Description copied from interface: Osgl.Bijection

Returns the inverse function mapping from Y back to X

Specified by:

invert in interface Osgl.Bijection<P1,R>

Returns:

a function that map Y type element to X type element

times

public Osgl.MultiplicableFunction<P1,R> times(int n)

Description copied from interface: Osgl.MultiplicableFunction

Returns a function with n times factor specified. When the function returned applied to a param, the effect is the same as apply this function n times to the same param

Specified by:

times in interface Osgl.MultiplicableFunction<P1,R>

Parameters:

n - specify the times factor

Returns:

the new function

applyOrElse

public R applyOrElse(P1 p1,
                     Osgl.F1<? super P1,? 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 argument this function to be applied

fallback - the function to be applied to the argument p1 when this function failed with any runtime exception

Returns:

the result of this function or the fallback function application

curry

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

andThen

public <T> Osgl.F1<P1,T> andThen(Osgl.Function<? super R,? extends T> after)

Returns a composed function that applies this function to it's input and then applies the after function to the result. If evaluation of either function throws an exception, it is relayed to the caller of the composed function.

Type Parameters:

T - the type of return value of the new composed function

Parameters:

after - the function applies after this function is applied

Returns:

the composed function

Throws:

NullPointerException - if @{code after} is null

andThen

public Osgl.F1<P1,R> andThen(Osgl.Function<? super P1,? extends R>... afters)

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:

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

Returns:

a composed function

orElse

public Osgl.F1<P1,R> orElse(Osgl.Function<? super P1,? 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

compose

public Osgl.F0<R> compose(Osgl.Func0<? extends P1> before)

Returns an F0<R>> function by composing the specified Func0&ltP1> function with this function applied last

Parameters:

before - the function to be applied first when applying the return function

Returns:

an new function such that f() == apply(f0())

compose

public <X1> Osgl.F1<X1,R> compose(Osgl.Function<? super X1,? extends P1> before)

Returns an F1<X1, R>> function by composing the specified Function&ltX1, P1> function with this function applied last

Type Parameters:

X1 - type of argument takes by the before function

Parameters:

before - the function to be applied first when applying the return function

Returns:

an new function such that f(a) == apply(f1(a))

compose

public <X1,X2> Osgl.F2<X1,X2,R> compose(Osgl.Func2<? super X1,? super X2,? extends P1> before)

Returns an F2<X1, X2, R>> function by composing the specified Func2&ltX1, X2, P1> function with this function applied last

Type Parameters:

X1 - the type of first param the new function applied to

X2 - the type of second param the new function applied to

Parameters:

before - the function to be applied first when applying the return function

Returns:

an new function such that f(x1, x2) == apply(f1(x1, x2))

compose

public <X1,X2,X3> Osgl.F3<X1,X2,X3,R> compose(Osgl.Func3<? super X1,? super X2,? super X3,? extends P1> before)

Returns an F3<X1, X2, X3, R>> function by composing the specified Func3&ltX1, X2, X3, P1> function with this function applied last

Type Parameters:

X1 - the type of first param the new function applied to

X2 - the type of second param the new function applied to

X3 - the type of third param the new function applied to

Parameters:

before - the function to be applied first when applying the return function

Returns:

an new function such that f(x1, x2, x3) == apply(f1(x1, x2, x3))

compose

public <X1,X2,X3,X4> Osgl.F4<X1,X2,X3,X4,R> compose(Osgl.Func4<? super X1,? super X2,? super X3,? super X4,? extends P1> before)

Returns an F3<X1, X2, X3, X4, R>> function by composing the specified Func3&ltX1, X2, X3, X4, P1> function with this function applied last

Type Parameters:

X1 - the type of first param the new function applied to

X2 - the type of second param the new function applied to

X3 - the type of third param the new function applied to

X4 - the type of fourth param the new function applied to

Parameters:

before - the function to be applied first when applying the return function

Returns:

an new function such that f(x1, x2, x3, x4) == apply(f1(x1, x2, x3, x4))

compose

public <X1,X2,X3,X4,X5> Osgl.F5<X1,X2,X3,X4,X5,R> compose(Osgl.Func5<? super X1,? super X2,? super X3,? super X4,? super X5,? extends P1> before)

Returns an F3<X1, X2, X3, X4, X5, R>> function by composing the specified Func3&ltX1, X2, X3, X4, X5, P1> function with this function applied last

Type Parameters:

X1 - the type of first param the new function applied to

X2 - the type of second param the new function applied to

X3 - the type of third param the new function applied to

X4 - the type of fourth param the new function applied to

X5 - the type of fifth param the new function applied to

Parameters:

before - the function to be applied first when applying the return function

Returns:

an new function such that f(x1, x2, x3, x4, x5) == apply(f1(x1, x2, x3, x4, x5))

lift

public Osgl.F1<P1,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.