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