1   /**
2    * Distribution License:
3    * JSword is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 as published by
5    * the Free Software Foundation. This program is distributed in the hope
6    * that it will be useful, but WITHOUT ANY WARRANTY; without even the
7    * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *       http://www.gnu.org/copyleft/lgpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * Copyright: 2005
18   *     The copyright to this program is held by it's authors.
19   *
20   * ID: $Id: KeyVisitor.java 2115 2011-03-12 20:29:39Z dmsmith $
21   */
22  package org.crosswire.jsword.passage;
23  
24  /**
25   * An interface for components wanting to visit all the nodes in a Key tree.
26   * 
27   * @see gnu.lgpl.License for license details.<br>
28   *      The copyright to this program is held by it's authors.
29   * @author DM Smith [dmsmith555 at yahoo dot com]
30   */
31  public interface KeyVisitor {
32      /**
33       * We've found a leaf node in a Key tree, and are giving the visitor a
34       * chance to do processing based on it.
35       * 
36       * @param key
37       *            The found leaf node.
38       */
39      void visitLeaf(Key key);
40  
41      /**
42       * We've found a branch node in a Key tree, and are giving the visitor a
43       * chance to do processing based on it.
44       * 
45       * @param key
46       *            The found branch node.
47       */
48      void visitBranch(Key key);
49  }
50