01: /*
02: * ====================================================================
03: *
04: * The Apache Software License, Version 1.1
05: *
06: * Copyright (c) 1999-2003 The Apache Software Foundation.
07: * All rights reserved.
08: *
09: * Redistribution and use in source and binary forms, with or without
10: * modification, are permitted provided that the following conditions
11: * are met:
12: *
13: * 1. Redistributions of source code must retain the above copyright
14: * notice, this list of conditions and the following disclaimer.
15: *
16: * 2. Redistributions in binary form must reproduce the above copyright
17: * notice, this list of conditions and the following disclaimer in
18: * the documentation and/or other materials provided with the
19: * distribution.
20: *
21: * 3. The end-user documentation included with the redistribution, if
22: * any, must include the following acknowledgement:
23: * "This product includes software developed by the
24: * Apache Software Foundation (http://www.apache.org/)."
25: * Alternately, this acknowledgement may appear in the software itself,
26: * if and wherever such third-party acknowledgements normally appear.
27: *
28: * 4. The names "The Jakarta Project", "Commons", and "Apache Software
29: * Foundation" must not be used to endorse or promote products derived
30: * from this software without prior written permission. For written
31: * permission, please contact apache@apache.org.
32: *
33: * 5. Products derived from this software may not be called "Apache"
34: * nor may "Apache" appear in their names without prior written
35: * permission of the Apache Software Foundation.
36: *
37: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48: * SUCH DAMAGE.
49: * ====================================================================
50: *
51: * This software consists of voluntary contributions made by many
52: * individuals on behalf of the Apache Software Foundation. For more
53: * information on the Apache Software Foundation, please see
54: * <http://www.apache.org/>.
55: *
56: */
57:
58: package org.apache.commons.jrcs.diff;
59:
60: /**
61: * A simple interface for implementations of differencing algorithms.
62: *
63: * @version $Revision: 7756 $ $Date: 2006-04-12 18:30:19 +0100 (Wed, 12 Apr
64: * 2006) $
65: * @author <a href="mailto:bwm@hplb.hpl.hp.com">Brian McBride</a>
66: */
67: public interface DiffAlgorithm {
68: /**
69: * Computes the difference between the original sequence and the revised
70: * sequence and returns it as a
71: * {@link org.apache.commons.jrcs.diff.Revision Revision} object.
72: * <p>
73: * The revision can be used to construct the revised sequence from the
74: * original sequence.
75: *
76: * @param rev
77: * the revised text
78: * @return the revision script.
79: * @throws DifferentiationFailedException
80: * if the diff could not be computed.
81: */
82: public abstract Revision diff(Object[] orig, Object[] rev)
83: throws DifferentiationFailedException;
84: }
|