KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > spi > diff > MergeVisualizer


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.spi.diff;
21
22 import java.awt.Component JavaDoc;
23 import java.io.IOException JavaDoc;
24
25 import org.netbeans.api.diff.Difference;
26 import org.netbeans.api.diff.StreamSource;
27
28 /**
29  * This class represents a merge visualizer. It's used as a visual conflicts
30  * resolution tool for the process of merging of file conflicts.
31  * <p>The registered Merge Visualizers can be obtained via {@link org.openide.util.Lookup}
32  * (e.g. you can get the default merge provider by
33  * <code>Lookup.getDefault().lookup(MergeVisualizer.class)</code>)
34  *
35  * @author Martin Entlicher
36  */
37 public abstract class MergeVisualizer extends Object JavaDoc {
38
39     /**
40      * Show the visual representation of the merging process of two sources.
41      * The result of the merging process can be saved into a Writer even
42      * before all conflicts are actually resolved.
43      *
44      * @param diffs The list of conflicts.
45      * @param source1 the source of the first file
46      * @param source2 the source of the second file
47      * @param result the information about the result source
48      * @return The Component representing the diff visual representation
49      * or null, when the representation is outside the IDE.
50      * @throws IOException when the reading from input streams fails.
51      */
52     public abstract Component JavaDoc createView(Difference[] diffs, StreamSource source1,
53                                          StreamSource source2, StreamSource result) throws IOException JavaDoc ;
54     
55 }
56
Popular Tags