All Downloads are FREE. Search and download functionalities are using the official Maven repository.

functionalj.function.Func2 Maven / Gradle / Ivy

There is a newer version: 1.0.17
Show newest version
// ============================================================================
// Copyright(c) 2017-2019 Nawapunth Manusitthipol (NawaMan - http://nawaman.net)
// ----------------------------------------------------------------------------
// MIT License
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
// ============================================================================
package functionalj.function;

import java.io.PrintStream;
import java.io.PrintWriter;
import java.util.Optional;
import java.util.function.BiFunction;
import java.util.function.BiPredicate;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Supplier;

import functionalj.functions.ThrowFuncs;
import functionalj.list.FuncList;
import functionalj.map.FuncMap;
import functionalj.promise.DeferAction;
import functionalj.promise.HasPromise;
import functionalj.promise.Promise;
import functionalj.result.Result;
import functionalj.stream.StreamPlus;
import functionalj.stream.ZipWithOption;
import functionalj.task.Task;
import functionalj.tuple.Tuple;
import functionalj.tuple.Tuple2;
import lombok.val;
import nullablej.nullable.Nullable;

/**
 * Function of two parameters.
 * 
 * @param   the first input data type.
 * @param   the second input data type.
 * @param   the output data type.
 * 
 * @author NawaMan -- [email protected]
 */
@FunctionalInterface
public interface Func2 extends BiFunction {
    
    public static  Func2 of(Func2 func) {
        return func;
    }
    
    public static  Func2 from(BiFunction func) {
        return func::apply;
    }
    
    public OUTPUT applyUnsafe(INPUT1 input1, INPUT2 input2) throws Exception;
    
    /**
     * Applies this function to the given input values.
     *
     * @param  input1  the first input.
     * @param  input2  the second input.
     * @return         the function result.
     */
    public default OUTPUT apply(INPUT1 input1, INPUT2 input2) {
        try {
            return applyUnsafe(input1, input2);
        } catch (RuntimeException e) {
            throw e;
        } catch (Exception e) {
            throw ThrowFuncs.exceptionTransformer.value().apply(e);
        }
    }
    
    /**
     * Applies this function to the given input values.
     *
     * @param  input the tuple input.
     * @return       the function result.
     */
    public default OUTPUT applyTo(Tuple2 input) {
        return apply(input._1(), input._2());
    }
    public default Func1 applyTo(INPUT1 input1) {
        return input2 -> apply(input1, input2);
    }
    public default Result applyTo(Result input1, Result input2) {
        return Result.ofResults(input1, input2, this);
    }
    public default Optional applyTo(Optional input1, Optional input2) {
        return input1.flatMap(i1 -> {
            return input2.map(i2 -> {
                return Func2.this.apply(i1, i2);
            });
        });
    }
    public default Nullable applyTo(Nullable input1, Nullable input2) {
        return input1.flatMap(i1 -> {
            return input2.map(i2 -> {
                return Func2.this.apply(i1, i2);
            });
        });
    }
    public default Promise applyTo(HasPromise input1, HasPromise input2) {
        return Promise.from(input1, input2, this);
    }
    public default Task applyTo(Task input1, Task input2) {
        return Task.from(input1, input2, this);
    }
    public default StreamPlus applyTo(StreamPlus input1, StreamPlus input2) {
        return input1.combine(input2, this);
    }
    public default StreamPlus applyTo(StreamPlus input1, StreamPlus input2, ZipWithOption option) {
        return input1.combine(input2, option, this);
    }
    public default FuncList applyTo(FuncList input1, FuncList input2) {
        return input1.combine(input2.stream(), this);
    }
    public default FuncList applyTo(FuncList input1, FuncList input2, ZipWithOption option) {
        return input1.combine(input2.stream(), option, this);
    }
    public default  FuncMap applyTo(FuncMap input1, FuncMap input2) {
        return input1.zipWith(input2, this);
    }
    public default  FuncMap applyTo(FuncMap input1, FuncMap input2, ZipWithOption option) {
        return input1.zipWith(input2, option, this);
    }
    public default Func0 applyTo(Supplier input1, Supplier input2) {
        return ()->apply(input1.get(), input2.get());
    }
    public default  Func1 applyTo(Func1 input1, Func1 input2) {
        return source -> {
            val i1 = input1.apply(source);
            val i2 = input2.apply(source);
            return apply(i1, i2);
        };
    }
    
    public default Result applySafely(INPUT1 input1, INPUT2 input2) {
        try {
            val output = applyUnsafe(input1, input2);
            return Result.valueOf(output);
        } catch (Exception exception) {
            return Result.ofException(exception);
        }
    }
    
    /**
     * Compose this function to the given function.
     * NOTE: Too bad the name 'compose' is already been taken :-(
     * 
     * @param    the target result value.
     * @param  after     the function to be run after this function.
     * @return           the composed function.
     */
    public default  Func2 then(Function after) {
        return (input1, input2) -> {
            OUTPUT output = this.applyUnsafe(input1, input2);
            TARGET target = Func.applyUnsafe(after, output);
            return target;
        };
    }
    public default  Func2 map(Function after) {
        return (input1, input2) -> {
            OUTPUT output = this.applyUnsafe(input1, input2);
            TARGET target = (output != null)
                          ? Func.applyUnsafe(after, output)
                          : null;
            return target;
        };
    }
    
    public default Func2 ifException(Consumer exceptionHandler) {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                return outputValue;
            } catch (Exception e) {
                exceptionHandler.accept(e);
                return null;
            }
        };
    }
    public default Func2 ifExceptionThenPrint() {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                return outputValue;
            } catch (Exception e) {
                e.printStackTrace();
                return null;
            }
        };
    }
    public default Func2 ifExceptionThenPrint(PrintStream printStream) {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                return outputValue;
            } catch (Exception e) {
                e.printStackTrace(printStream);
                return null;
            }
        };
    }
    public default Func2 ifExceptionThenPrint(PrintWriter printWriter) {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                return outputValue;
            } catch (Exception e) {
                e.printStackTrace(printWriter);
                return null;
            }
        };
    }
    
    public default Func2 whenAbsentUse(OUTPUT defaultValue) {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                val returnValue 
                        = (outputValue != null)
                        ? outputValue
                        : defaultValue;
                return returnValue;
            } catch (Exception e) {
                return defaultValue;
            }
        };
    }
    public default Func2 whenAbsentGet(Supplier defaultSupplier) {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                val returnValue 
                        = (outputValue != null)
                        ? outputValue
                        : defaultSupplier.get();
                return returnValue;
            } catch (Exception e) {
                return defaultSupplier.get();
            }
        };
    }
    public default Func2 whenAbsentApply(Func1 exceptionMapper) {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                val returnValue 
                        = (outputValue != null)
                        ? outputValue
                        : exceptionMapper.apply(null);
                return returnValue;
            } catch (Exception e) {
                return exceptionMapper.apply(e);
            }
        };
    }
    public default Func2 whenAbsentApply(Func3 exceptionMapper) {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                val returnValue 
                        = (outputValue != null)
                        ? outputValue
                        : exceptionMapper.apply(input1, input2, null);
                return returnValue;
            } catch (Exception e) {
                return exceptionMapper.apply(input1, input2, e);
            }
        };
    }
    public default Func2 whenAbsentApply(Func2, Exception, OUTPUT> exceptionMapper) {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                val returnValue 
                        = (outputValue != null)
                        ? outputValue
                        : exceptionMapper.apply(Tuple.of(input1, input2), null);
                return returnValue;
            } catch (Exception e) {
                return exceptionMapper.apply(Tuple.of(input1, input2), e);
            }
        };
    }
    
    public default Func2 whenAbsentUse(Consumer exceptionHandler, OUTPUT defaultValue) {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                val returnValue 
                        = (outputValue != null)
                        ? outputValue
                        : defaultValue;
                return returnValue;
            } catch (Exception e) {
                exceptionHandler.accept(e);
                return defaultValue;
            }
        };
    }
    public default Func2 whenAbsentGet(Consumer exceptionHandler, Supplier defaultSupplier) {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                val returnValue 
                        = (outputValue != null)
                        ? outputValue
                        : defaultSupplier.get();
                return returnValue;
            } catch (Exception e) {
                exceptionHandler.accept(e);
                return defaultSupplier.get();
            }
        };
    }
    public default Func2 whenAbsentApply(Consumer exceptionHandler, Func1 exceptionMapper) {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                val returnValue 
                        = (outputValue != null)
                        ? outputValue
                        : exceptionMapper.apply(null);
                return returnValue;
            } catch (Exception e) {
                exceptionHandler.accept(e);
                return exceptionMapper.apply(e);
            }
        };
    }
    public default Func2 whenAbsentApply(Consumer exceptionHandler, Func3 exceptionMapper) {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                val returnValue 
                        = (outputValue != null)
                        ? outputValue
                        : exceptionMapper.apply(input1, input2, null);
                return returnValue;
            } catch (Exception e) {
                exceptionHandler.accept(e);
                return exceptionMapper.apply(input1, input2, e);
            }
        };
    }
    public default Func2 whenAbsentApply(Consumer exceptionHandler, Func2, Exception, OUTPUT> exceptionMapper) {
        return (input1, input2)->{
            try {
                val outputValue = this.applyUnsafe(input1, input2);
                val returnValue 
                        = (outputValue != null)
                        ? outputValue
                        : exceptionMapper.apply(Tuple.of(input1, input2), null);
                return returnValue;
            } catch (Exception e) {
                exceptionHandler.accept(e);
                return exceptionMapper.apply(Tuple.of(input1, input2), e);
            }
        };
    }
    
    public default OUTPUT orElse(INPUT1 input1, INPUT2 input2, OUTPUT defaultValue) {
        return applySafely(input1, input2).orElse(defaultValue);
    }
    
    public default OUTPUT orGet(INPUT1 input1, INPUT2 input2, Supplier defaultSupplier) {
        return applySafely(input1, input2).orGet(defaultSupplier);
    }
    
    public default Func2> safely() {
        return Func.of(this::applySafely);
    }
    
    public default Func2> optionally() {
        return (input1, input2) -> {
            try {
                return Optional.ofNullable(this.applyUnsafe(input1, input2));
            } catch (Exception e) {
                return Optional.empty();
            }
        };
    }
    
    public default Func2> async() {
        return (input1, input2) -> {
            val supplier = (Func0)()->{
                return this.applyUnsafe(input1, input2);
            };
            return DeferAction.from(supplier)
                    .start().getPromise();
        };
    }
    
    public default Func2, HasPromise, Promise> defer() {
        return (promise1, promise2) -> {
            return Promise.from(promise1, promise2, this);
        };
    }
    
    public default FuncUnit2 ignoreResult() {
        return FuncUnit2.of((input1, input2)->applyUnsafe(input1, input2));
    }
    
    public default Func1, OUTPUT> wholly() {
        return t -> this.applyUnsafe(t._1(), t._2());
    }
    
    public default BiPredicate toPredicate() {
        return (i1, i2) -> Boolean.TRUE.equals(apply(i1, i2));
    }
    
    public default BiPredicate toPredicate(Func1 toPredicate) {
        return (i1, i2) -> toPredicate.apply((apply(i1, i2)));
    }
    
    /**
     * Flip the parameter order.
     * 
     * @return  the Func2 with parameter in a flipped order.
     */
    public default Func2 flip() {
        return (i2, i1) -> this.applyUnsafe(i1, i2);
    }
    
    public default Func1> elevate() {
        return (i2) -> (i1) -> this.applyUnsafe(i1, i2);
    }
    
    public default Func1 elevateWith(INPUT2 i2) {
        return (i1) -> this.applyUnsafe(i1, i2);
    }
    public default Func1, Result> elevateWith(Result i2) {
        return (i1) -> this.applyTo(i1, i2);
    }
    public default Func1, Promise> elevateWith(HasPromise i2) {
        return (i1) -> this.applyTo(i1, i2);
    }
    
    public default Func1> split() {
        return split1();
    }
    public default Func1> split1() {
        return (i1) -> (i2) -> this.applyUnsafe(i1, i2);
    }
    
    
    //== Partially apply functions ==
    
    @SuppressWarnings("javadoc")
    public default Func0 bind(INPUT1 i1, INPUT2 i2) {
        return () -> this.applyUnsafe(i1, i2);
    }
    @SuppressWarnings("javadoc")
    public default Func1 bind1(INPUT1 i1) {
        return i2 -> this.applyUnsafe(i1, i2);
    }
    
    @SuppressWarnings("javadoc")
    public default Func1 bind2(INPUT2 i2) {
        return i1 -> this.applyUnsafe(i1, i2);
    }
    
    @SuppressWarnings("javadoc")
    public default Func1 bind(Absent a1, INPUT2 i2) {
        return i1 -> this.applyUnsafe(i1, i2);
    }
    @SuppressWarnings("javadoc")
    public default Func1 bind(INPUT1 i1, Absent a2) {
        return i2 -> this.applyUnsafe(i1, i2);
    }
    
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy