org.spearce.jgit/src/org/spearce/jgit/lib/IndexTreeVisitor.java

   1 /*
   2  * Copyright (C) 2007, Dave Watson <dwatson@mimvista.com>
   3  * Copyright (C) 2008, Robin Rosenberg <robin.rosenberg@dewire.com>
   4  * Copyright (C) 2006, Shawn O. Pearce <spearce@spearce.org>
   5  *
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or
   9  * without modification, are permitted provided that the following
  10  * conditions are met:
  11  *
  12  * - Redistributions of source code must retain the above copyright
  13  *   notice, this list of conditions and the following disclaimer.
  14  *
  15  * - Redistributions in binary form must reproduce the above
  16  *   copyright notice, this list of conditions and the following
  17  *   disclaimer in the documentation and/or other materials provided
  18  *   with the distribution.
  19  *
  20  * - Neither the name of the Git Development Community nor the
  21  *   names of its contributors may be used to endorse or promote
  22  *   products derived from this software without specific prior
  23  *   written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  26  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  27  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  28  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  30  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  31  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  32  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  33  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  34  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  35  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  37  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38  */
  39
  40 package org.spearce.jgit.lib;
  41
  42 import java.io.File;
  43 import java.io.IOException;
  44
  45 import org.spearce.jgit.lib.GitIndex.Entry;
  46
  47 /**
  48  * Visitor interface for traversing the index and two trees in parallel.
  49  *
  50  * When merging we deal with up to two tree nodes and a base node. Then
  51  * we figure out what to do.
  52  *
  53  * A File argument is supplied to allow us to check for modifications in
  54  * a work tree or update the file.
  55  */
  56 public interface IndexTreeVisitor {
  57         /**
  58          * Visit a blob, and corresponding tree and index entries.
  59          *
  60          * @param treeEntry
  61          * @param indexEntry
  62          * @param file
  63          * @throws IOException
  64          */
  65         public void visitEntry(TreeEntry treeEntry, Entry indexEntry, File file) throws IOException;
  66
  67         /**
  68          * Visit a blob, and corresponding tree nodes and associated index entry.
  69          *
  70          * @param treeEntry
  71          * @param auxEntry
  72          * @param indexEntry
  73          * @param file
  74          * @throws IOException
  75          */
  76         public void visitEntry(TreeEntry treeEntry, TreeEntry auxEntry, Entry indexEntry, File file) throws IOException;
  77
  78         /**
  79          * Invoked after handling all child nodes of a tree, during a three way merge
  80          *
  81          * @param tree
  82          * @param auxTree
  83          * @param curDir
  84          * @throws IOException
  85          */
  86         public void finishVisitTree(Tree tree, Tree auxTree, String curDir) throws IOException;
  87
  88         /**
  89          * Invoked after handling all child nodes of a tree, during two way merge.
  90          *
  91          * @param tree
  92          * @param i
  93          * @param curDir
  94          * @throws IOException
  95          */
  96         public void finishVisitTree(Tree tree, int i, String curDir) throws IOException;
  97 }