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