001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.utils;
018
019import java.util.function.*;
020
021/**
022 * Allows you to perform a function against 5 objects.
023 *
024 * <p>
025 * Similar to {@link BiFunction} except for 5 parameters.
026 *
027 * <p class='bjava'>
028 *    Tuple5Function&lt;A,B,C,D,E,R&gt; <jv>x</jv> = (<jv>a</jv>,<jv>b</jv>,<jv>c</jv>,<jv>d</jv>,<jv>e</jv>) -&gt; <jsm>doSomething</jsm>(<jv>a</jv>,<jv>b</jv>,<jv>c</jv>,<jv>d</jv>,<jv>e</jv>);
029 *
030 *    R <jv>result</jv> = <jv>x</jv>.apply(<jv>xa</jv>,<jv>xb</jv>,<jv>xc</jv>,<jv>xd</jv>,<jv>xe</jv>);
031 * </p>
032 *
033 * <h5 class='section'>See Also:</h5><ul>
034 * </ul>
035 *
036 * @param <A> Object 1 type.
037 * @param <B> Object 2 type.
038 * @param <C> Object 3 type.
039 * @param <D> Object 4 type.
040 * @param <E> Object 5 type.
041 * @param <R> Result type.
042 */
043@FunctionalInterface
044public interface Tuple5Function<A,B,C,D,E,R> {
045
046   @SuppressWarnings("javadoc")
047   R apply(A a, B b, C c, D d, E e);
048
049   @SuppressWarnings("javadoc")
050   default <V> Tuple5Function<A,B,C,D,E,V> andThen(Function<? super R, ? extends V> after) {
051      return (A a, B b, C c, D d, E e) -> after.apply(apply(a, b, c, d, e));
052   }
053}