com.github.dm.jrt.function.BiFunctionWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jroutine Show documentation
Parallel programming on the go
There is a newer version: 5.9.0
/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.github.dm.jrt.function;

import com.github.dm.jrt.util.Reflection;

import org.jetbrains.annotations.NotNull;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

/**
 * Class wrapping a bi-function instance.
 * 
 * Created by davide-maestroni on 10/16/2015.
 *
 * @param  the first input data type.
 * @param  the second input data type.
 * @param  the output data type.
 */
public class BiFunctionWrapper implements BiFunction {

    private final BiFunction mBiFunction;

    private final FunctionWrapper mFunction;

    /**
     * Constructor.
     *
     * @param biFunction the initial wrapped supplier.
     * @param function   the concatenated function chain.
     */
    @SuppressWarnings("ConstantConditions")
    BiFunctionWrapper(@NotNull final BiFunction biFunction,
            @NotNull final FunctionWrapper function) {

        if (biFunction == null) {

            throw new NullPointerException("the bi-function instance must not be null");
        }

        if (function == null) {

            throw new NullPointerException("the function wrapper must not be null");
        }

        mBiFunction = biFunction;
        mFunction = function;
    }

    /**
     * Returns a composed bi-function wrapper that first applies this function to its input, and
     * then applies the after function to the result.
     *
     * @param after   the function to apply after this function is applied.
     * @param  the type of output of the after function.
     * @return the composed bi-function.
     */
    @NotNull
    @SuppressFBWarnings(value = "BC_UNCONFIRMED_CAST",
            justification = "class comparison with == is done")
    public  BiFunctionWrapper andThen(
            @NotNull final Function after) {

        return new BiFunctionWrapper(mBiFunction, mFunction.andThen(after));
    }

    @SuppressWarnings("unchecked")
    public OUT apply(final IN1 in1, final IN2 in2) {

        return ((FunctionWrapper) mFunction).apply(mBiFunction.apply(in1, in2));
    }

    /**
     * Checks if the functions wrapped by this instance have a static context.
     *
     * @return whether the functions have a static context.
     */
    public boolean hasStaticContext() {

        final BiFunction biFunction = mBiFunction;
        return Reflection.hasStaticContext(biFunction.getClass()) && mFunction.hasStaticContext();
    }

    @Override
    public int hashCode() {

        int result = mBiFunction.getClass().hashCode();
        result = 31 * result + mFunction.hashCode();
        return result;
    }

    @Override
    public boolean equals(final Object o) {

        if (this == o) {

            return true;
        }

        if ((o == null) || (getClass() != o.getClass())) {

            return false;
        }

        final BiFunctionWrapper that = (BiFunctionWrapper) o;
        return (mBiFunction.getClass() == that.mBiFunction.getClass()) && mFunction.equals(
                that.mFunction);
    }
}