com.cinchapi.common.function.TriFunction Maven / Gradle / Ivy
Show all versions of accent4j Show documentation
/*
* Copyright (c) 2013-2018 Cinchapi Inc.
*
* 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.cinchapi.common.function;
import java.util.Objects;
import java.util.function.BiFunction;
import java.util.function.Function;
/**
* Represents a function that accepts three arguments and produces a result.
* This is the three-arity specialization of {@link Function}.
*
*
* This is a functional interface
* whose functional method is {@link #apply(Object, Object, Object)}.
*
* @param the type of the first argument to the function
* @param the type of the second argument to the function
* @param the type of the third argument to the function
* @param the type of the result of the function
*
* @see Function
* @see BiFunction
*
* @author Jeff Nelson
*/
@FunctionalInterface
public interface TriFunction {
/**
* Applies this function to the given arguments.
*
* @param f the first function argument
* @param s the second function argument
* @param t the third function argument
* @return the function result
*/
public R apply(F f, S s, T t);
/**
* Returns a composed function that first applies this function to
* its input, and then applies the {@code after} function to the result.
* If evaluation of either function throws an exception, it is relayed to
* the caller of the composed function.
*
* @param the type of output of the {@code after} function, and of the
* composed function
* @param after the function to apply after this function is applied
* @return a composed function that first applies this function and then
* applies the {@code after} function
* @throws NullPointerException if after is null
*/
public default TriFunction andThen(
Function after) {
Objects.requireNonNull(after);
return (F f, S s, T t) -> after.apply(apply(f, s, t));
}
}