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.collections4.sequence;
18
19 import java.util.List;
20
21 /**
22 * This interface is devoted to handle synchronized replacement sequences.
23 *
24 * @param <T> the type of elements in the lists.
25 * @see ReplacementsFinder
26 * @since 4.0
27 */
28 @FunctionalInterface
29 public interface ReplacementsHandler<T> {
30
31 /**
32 * Handles two synchronized sequences.
33 * <p>
34 * This method is called by a {@link ReplacementsFinder ReplacementsFinder}
35 * instance when it has synchronized two sub-sequences of object arrays
36 * being compared, and at least one of the sequences is non-empty. Since the
37 * sequences are synchronized, the objects before the two sub-sequences are
38 * equals (if they exist). This property also holds for the objects after
39 * the two sub-sequences.
40 * </p>
41 * <p>
42 * The replacement is defined as replacing the {@code from}
43 * sub-sequence into the {@code to} sub-sequence.
44 * </p>
45 *
46 * @param skipped number of tokens skipped since the last call (i.e. number of
47 * tokens that were in both sequences), this number should be strictly positive
48 * except on the very first call where it can be zero (if the first object of
49 * the two sequences are different)
50 * @param from sub-sequence of objects coming from the first sequence
51 * @param to sub-sequence of objects coming from the second sequence
52 */
53 void handleReplacement(int skipped, List<T> from, List<T> to);
54
55 }