1 package org.synchronoss.cpo.core;
2
3 /*-
4 * [[
5 * core
6 * ==
7 * Copyright (C) 2003 - 2026 Exaxis LLC, Synchronoss Technologies Inc
8 * ==
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation, either version 3 of the
12 * License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Lesser Public License for more details.
18 *
19 * You should have received a copy of the GNU General Lesser Public
20 * License along with this program. If not, see
21 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22 * ]]
23 */
24
25 /** This is the interface for the visitors to the Node Hierarchy */
26 public interface NodeVisitor {
27
28 /**
29 * This is called by composite nodes prior to visiting children
30 *
31 * @param node The node to be visited
32 * @return a boolean (false) to end visit or (true) to continue visiting
33 */
34 boolean visitBegin(Node node);
35
36 /**
37 * This is called for composite nodes between visiting children
38 *
39 * @param node The node to be visited
40 * @return a boolean (false) to end visit or (true) to continue visiting
41 */
42 boolean visitMiddle(Node node);
43
44 /**
45 * This is called by composite nodes after visiting children
46 *
47 * @param node The node to be visited
48 * @return a boolean (false) to end visit or (true) to continue visiting
49 */
50 boolean visitEnd(Node node);
51
52 /**
53 * This is called for component elements which have no children
54 *
55 * @param node The element to be visited
56 * @return a boolean (false) to end visit or (true) to continue visiting
57 */
58 boolean visit(Node node);
59 }