1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.functor;
18
19 /**
20 * A functor that takes two arguments and returns a value.
21 * <p>
22 * Implementors are encouraged but not required to make their functors
23 * {@link java.io.Serializable Serializable}.
24 * </p>
25 * @param <L> the left argument type.
26 * @param <R> the right argument type.
27 * @param <T> the returned value type.
28 * @since 1.0
29 * @version $Revision: 1156732 $ $Date: 2011-08-11 20:55:42 +0200 (Thu, 11 Aug 2011) $
30 * @author Rodney Waldhoff
31 */
32 public interface BinaryFunction<L, R, T> extends BinaryFunctor<L, R> {
33 /**
34 * Evaluate this function.
35 *
36 * @param left the L element of the ordered pair of arguments
37 * @param right the R element of the ordered pair of arguments
38 * @return the T result of this function for the given arguments
39 */
40 T evaluate(L left, R right);
41 }