01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: /*
43: * Diff.java
44: *
45: * Created on February 2, 2001, 2:53 PM
46: */
47:
48: package org.netbeans.junit.diff;
49:
50: /**
51: * This interface must be implemented by any class used as file-diff facility in assertFile functions.
52: * It declares two functions, which are called whenever the file comparision is required. Their meaning
53: * is identical, they only differ by arguments types.
54: *
55: * Generally, they both take three parameters, the first two specify files being compared and the third
56: * is the file, where comparision results are stored. Third paramtere can be null in case no additional
57: * output except the return value is needed.
58: *
59: * @author Jan Becicka
60: * @version 0.1
61: * @see junit.framework.Assert Assert class
62: */
63: public interface Diff {
64:
65: /**
66: * @param first first file to compare
67: * @param second second file to compare
68: * @param diff difference file, caller can pass null value, when results are not needed.
69: * @return true iff files differ
70: */
71: public boolean diff(final java.io.File first,
72: final java.io.File second, java.io.File diff)
73: throws java.io.IOException;
74:
75: /**
76: * @param first first file to compare
77: * @param second second file to compare
78: * @param diff difference file, caller can pass null value, when results are not needed.
79: * @return true iff files differ
80: */
81: public boolean diff(final String first, final String second,
82: String diff) throws java.io.IOException;
83:
84: }
|