KeyVisitor.java |
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 or later 5 * as published by the Free Software Foundation. This program is distributed 6 * in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even 7 * the 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 * © CrossWire Bible Society, 2005 - 2016 18 * 19 */ 20 package org.crosswire.jsword.passage; 21 22 /** 23 * An interface for components wanting to visit all the nodes in a Key tree. 24 * 25 * @see gnu.lgpl.License The GNU Lesser General Public License for details. 26 * @author DM Smith 27 */ 28 public interface KeyVisitor { 29 /** 30 * We've found a leaf node in a Key tree, and are giving the visitor a 31 * chance to do processing based on it. 32 * 33 * @param key 34 * The found leaf node. 35 */ 36 void visitLeaf(Key key); 37 38 /** 39 * We've found a branch node in a Key tree, and are giving the visitor a 40 * chance to do processing based on it. 41 * 42 * @param key 43 * The found branch node. 44 */ 45 void visitBranch(Key key); 46 } 47