AstVisitable.java

biz/hammurapi/antlr/AstVisitable.java

Violations

Inspector	Message	Severity	Location
Java Inspector 048	Copyrights information should be present in each file.	1
Java Inspector 089	Undocumented method	2	40:9
Java Inspector 089	Constructor is not properly documented	2	72:9
Java Inspector 089	Parameter node is not documented	2	72:9
Java Inspector 089	Undocumented parameter withSiblings	2	72:9
Java Inspector 040	Parameter name node clashes with field name in AstVisitable	3	55:32

Source code

1/*
2  * hgcommons 9
3 * Hammurapi Group Common Library
4 * Copyright (C) 2003  Hammurapi Group
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19 *
20 * URL: http://www.hammurapi.biz/hammurapi-biz/ef/xmenu/hammurapi-group/products/products/hgcommons/index.html
21 * e-Mail: support@hammurapi.biz
22 */
23package biz.hammurapi.antlr;
24
25import antlr.collections.AST;
26import biz.hammurapi.util.PoliteVisitor;
27import biz.hammurapi.util.Visitable;
28import biz.hammurapi.util.Visitor;
29
30
31/**
32 * Navigates Visitor through DOM tree.
33 * @author Pavel Vlasov
34 * @version $Revision: 1.2 $
35 */
36public class AstVisitable implements Visitable {
37	private AST node;
38	private boolean withSiblings;
39
40	public boolean accept(Visitor visitor) {
41		if (withSiblings) {
42			for (AST ast=node; ast!=null; ast=ast.getNextSibling()) {
43				accept(ast, visitor);
44			}			
45			return true;
46		}
47		
48		return accept(node, visitor);
49	}
50	
51	/**
52	 * @param node
53	 * @param visitor
54	 */
55	private boolean accept(AST node, Visitor visitor) {
56		if (visitor.visit(node)) {
57			for (AST child=node.getFirstChild(); child!=null; child=child.getNextSibling()) {
58				accept(child, visitor);
59			}
60			if (visitor instanceof PoliteVisitor) {
61				((PoliteVisitor) visitor).leave(node);
62			}
63			return true;
64		}
65		
66		return false;
67	}
68
69	/**
70	 * @param node
71	 */
72	public AstVisitable(AST node, boolean withSiblings) {
73		super();
74		this.node = node;
75		this.withSiblings=withSiblings;
76	}
77}
78