org.osgl

Class Osgl.Predicate<T>

java.lang.Object

org.osgl.Osgl.FuncBase

org.osgl.Osgl.F1<T,Boolean>

org.osgl.Osgl.Predicate<T>

All Implemented Interfaces:

Osgl.Bijection<T,Boolean>, Osgl.Func1<T,Boolean>, Osgl.Function<T,Boolean>, Osgl.MultiplicableFunction<T,Boolean>

Enclosing class:

Osgl

public abstract static class Osgl.Predicate<T>
extends Osgl.F1<T,Boolean>

Predicate is a predefined Function<Boolean, T> typed function with a set of utilities dealing with boolean operations. This is often known as Predicate

Note in user application, it should NOT assume an argument is of Predicate typed function, instead the argument should always be declared as Function<Boolean T>:

     // bad way
     void foo(Predicate<MyData> predicate) {
         ...
     }
     // good way
     void foo(Function<Boolean, MyData> predicate) {
         Predicate<MyData> p = Osgl.predicate(predicate);
         ...
     }
 

Since:

0.2

Constructor Summary

Constructors

Constructor and Description
Predicate()

Method Summary

Modifier and Type	Method and Description
Osgl.Predicate<T>	and(Osgl.Function<? super T,Boolean>... predicates) Return an Predicate predicate from a list of Function<Boolean, T> with AND operation.
Boolean	apply(T t) Apply this function to <T> type parameter.
<R> Osgl.F1<T,Osgl.Option<R>>	elseThen(Osgl.Function<? super T,R> func)
<R> Osgl.F1<T,Osgl.Option<R>>	ifThen(Osgl.Function<? super T,R> func)
Osgl.Predicate<T>	negate() Returns a negate function of this
static <T> Osgl.Predicate<T>	negate(Osgl.Function<T,Boolean> predicate)
Osgl.Predicate<T>	or(Osgl.Function<? super T,Boolean>... predicates) Return an Predicate predicate from a list of Function<Boolean, T> with OR operation.
abstract boolean	test(T t) Sub class to implement this method to test on the supplied elements

Methods inherited from class org.osgl.Osgl.F1

andThen, andThen, applyOrElse, compose, compose, compose, compose, compose, compose, curry, invert, lift, orElse, times

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

Constructor Detail

Predicate

public Predicate()

Method Detail

apply

public final Boolean apply(T t)

Description copied from interface: Osgl.Function

Apply this function to <T> type parameter.

In case implementing a partial function, it can throw out an NotAppliedException if the function is not defined for the given parameter(s)

Parameters:

t - the argument

Returns:

U type result

test

public abstract boolean test(T t)

Sub class to implement this method to test on the supplied elements

Parameters:

t - the element to be test

Returns:

true or false depends on the implementation

negate

public Osgl.Predicate<T> negate()

Returns a negate function of this

Returns:

the negate function

and

public Osgl.Predicate<T> and(Osgl.Function<? super T,Boolean>... predicates)

Return an Predicate predicate from a list of Function<Boolean, T> with AND operation. For any T t to be tested, if any specified predicates must returns false on it, the resulting predicate will return false.

Parameters:

predicates - the predicate function array

Returns:

a function that returns true only when all functions in predicates returns true on a given argument

Since:

0.2

or

public Osgl.Predicate<T> or(Osgl.Function<? super T,Boolean>... predicates)

Return an Predicate predicate from a list of Function<Boolean, T> with OR operation. For any T t to be tested, if any specified predicates must returns true on it, the resulting predicate will return true.

Parameters:

predicates - the predicate functions

Returns:

a function returns true if any one of the predicate functions returns true on a given argument

Since:

0.2

ifThen

public <R> Osgl.F1<T,Osgl.Option<R>> ifThen(Osgl.Function<? super T,R> func)

elseThen

public <R> Osgl.F1<T,Osgl.Option<R>> elseThen(Osgl.Function<? super T,R> func)

negate

public static <T> Osgl.Predicate<T> negate(Osgl.Function<T,Boolean> predicate)