1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 package org.openoffice.xmerge.merger;
25 
26 /**
27  * This is the difference algorithm interface.  It is an interface so
28  * that different algorithms may be plugged-in to actually compute
29  * the differences.
30  *
31  * NOTE: this code may not be thread safe.
32  */
33 public interface DiffAlgorithm {
34 
35     /**
36      *  Returns a <code>Difference</code> array.  This method finds out
37      *  the difference between two sequences.
38      *
39      *  @param  orgSeq  The original sequence of object.
40      *  @param  modSeq  The modified (or changed) sequence to
41      *                  compare against with the origial.
42      *
43      *  @return  A <code>Difference</code> array.
44      */
computeDiffs(Iterator orgSeq, Iterator modSeq)45     public Difference[] computeDiffs(Iterator orgSeq, Iterator modSeq);
46 }
47 
48