    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.commons.collections4.sequence;
    018
    019import java.util.List;
    020
    021/**
    022 * This interface is devoted to handle synchronized replacement sequences.
    023 *
    024 * @see ReplacementsFinder
    025 * @since 4.0
    026 */
    027@FunctionalInterface
    028public interface ReplacementsHandler<T> {
    029
    030    /**
    031     * Handle two synchronized sequences.
    032     * <p>
    033     * This method is called by a {@link ReplacementsFinder ReplacementsFinder}
    034     * instance when it has synchronized two sub-sequences of object arrays
    035     * being compared, and at least one of the sequences is non-empty. Since the
    036     * sequences are synchronized, the objects before the two sub-sequences are
    037     * equals (if they exist). This property also holds for the objects after
    038     * the two sub-sequences.
    039     * <p>
    040     * The replacement is defined as replacing the <code>from</code>
    041     * sub-sequence into the <code>to</code> sub-sequence.
    042     *
    043     * @param skipped  number of tokens skipped since the last call (i.e. number of
    044     *   tokens that were in both sequences), this number should be strictly positive
    045     *   except on the very first call where it can be zero (if the first object of
    046     *   the two sequences are different)
    047     * @param from  sub-sequence of objects coming from the first sequence
    048     * @param to  sub-sequence of objects coming from the second sequence
    049     */
    050    void handleReplacement(int skipped, List<T> from, List<T> to);
    051
    052}