CollectionVisitable.java

biz/hammurapi/util/CollectionVisitable.java

Violations

Inspector Message Severity Location
Java Inspector 048 Copyrights information should be present in each file. 1
Java Inspector 089 Undocumented method 2 37:5
Java Inspector 089 Constructor is not properly documented 2 62:5
Java Inspector 089 Parameter collection is not documented 2 62:5

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.util;
24
25import java.util.Collection;
26import java.util.Iterator;
27
28/**
29 * Converts collection into visitable
30 * @author Pavel Vlasov
31 * @version $Revision: 1.5 $
32 */
33public class CollectionVisitable implements Visitable {
34 private Collection collection;
35 private boolean visitCollection;
36
37 public boolean accept(Visitor visitor) {
38 if (visitor==null || collection==null) {
39 return false;
40 }
41
42 if (!visitCollection || visitor.visit(collection)) {
43 Iterator it=collection.iterator();
44 while (it.hasNext()) {
45 VisitableBase.object2visitor(it.next(), visitor);
46 }
47
48 if (visitCollection && visitor instanceof PoliteVisitor) {
49 ((PoliteVisitor) visitor).leave(collection);
50 }
51 return true;
52 }
53
54 return false;
55 }
56
57
58 /**
59 * @param collection
60 * @param visitCollection true - visitor visits the collection and its elements; false - only elements
61 */
62 public CollectionVisitable(Collection collection, boolean visitCollection) {
63 super();
64 this.collection = collection;
65 this.visitCollection=visitCollection;
66 }
67}
68