wayang-profiler/src/main/java/org/apache/wayang/profiler/log/sampling/Battle.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.wayang.profiler.log.sampling;

/**
 * Implementation of a battle between to elements.
 */
@FunctionalInterface
public interface Battle<T> {

    /**
     * Let to elements compete.
     *
     * @param t1 the first element
     * @param t2 the second element
     * @return the winner element, i.e., either {@code t1} or {@code t2}
     */
    T battle(T t1, T t2);

}