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

   1 /*
   2  * Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com>
   3  * Copyright (C) 2007, Shawn O. Pearce <spearce@spearce.org>
   4  *
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or
   8  * without modification, are permitted provided that the following
   9  * conditions are met:
  10  *
  11  * - Redistributions of source code must retain the above copyright
  12  *   notice, this list of conditions and the following disclaimer.
  13  *
  14  * - Redistributions in binary form must reproduce the above
  15  *   copyright notice, this list of conditions and the following
  16  *   disclaimer in the documentation and/or other materials provided
  17  *   with the distribution.
  18  *
  19  * - Neither the name of the Git Development Community nor the
  20  *   names of its contributors may be used to endorse or promote
  21  *   products derived from this software without specific prior
  22  *   written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  25  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  26  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  27  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  29  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  31  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  34  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  36  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37  */
  38
  39 package org.spearce.jgit.lib;
  40
  41 import java.io.IOException;
  42
  43 /**
  44  * A TreeVisitor is invoked depth first for every node in a tree and is expected
  45  * to perform different actions.
  46  */
  47 public interface TreeVisitor {
  48         /**
  49          * Visit to a tree node before child nodes are visited.
  50          *
  51          * @param t
  52          *            Tree
  53          * @throws IOException
  54          */
  55         public void startVisitTree(final Tree t) throws IOException;
  56
  57         /**
  58          * Visit to a tree node. after child nodes have been visited.
  59          *
  60          * @param t Tree
  61          * @throws IOException
  62          */
  63         public void endVisitTree(final Tree t) throws IOException;
  64
  65         /**
  66          * Visit to a blob.
  67          *
  68          * @param f Blob
  69          * @throws IOException
  70          */
  71         public void visitFile(final FileTreeEntry f) throws IOException;
  72
  73         /**
  74          * Visit to a symlink.
  75          *
  76          * @param s Symlink entry
  77          * @throws IOException
  78          */
  79         public void visitSymlink(final SymlinkTreeEntry s) throws IOException;
  80 }