Source code: com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/SymTabASTIterator.java
1
2 // Transmogrify License
3 //
4 // Copyright (c) 2001, ThoughtWorks, Inc.
5 // All rights reserved.
6 // Redistribution and use in source and binary forms, with or without
7 // modification, are permitted provided that the following conditions
8 // are met:
9 // - Redistributions of source code must retain the above copyright notice,
10 // this list of conditions and the following disclaimer.
11 // - Redistributions in binary form must reproduce the above copyright
12 // notice, this list of conditions and the following disclaimer in the
13 // documentation and/or other materials provided with the distribution.
14 // Neither the name of the ThoughtWorks, Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from this
16 // software without specific prior written permission.
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
24 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
27 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
30
31 import java.util.Iterator;
32 import java.util.NoSuchElementException;
33
34 /**
35 * An iterator for the children of a tree node.
36 *
37 * @version 1.0
38 * @since 1.0
39 * @see Iterator
40 */
41 public class SymTabASTIterator implements Iterator {
42 private SymTabAST _current;
43
44 /**
45 * Creates a new <tt>SymTabASTIterator</tt>.
46 *
47 * @param parent the node whose children will be iterated over.
48 */
49 public SymTabASTIterator(SymTabAST parent) {
50 _current = (SymTabAST)parent.getFirstChild();
51 }
52
53 /**
54 * Whether the node has another child. (In other words, returns
55 * <tt>true</tt> if <tt>next</tt> would return an element rather than
56 * throwing an exception.)
57 *
58 * @return the next child node.
59 */
60 public boolean hasNext() {
61 return (_current != null);
62 }
63
64 /**
65 * The next child node.
66 *
67 * @return the next child node.
68 */
69 public Object next() {
70 if (!hasNext()) {
71 throw new NoSuchElementException();
72 }
73
74 Object result = _current;
75 _current = (SymTabAST)_current.getNextSibling();
76
77 return result;
78 }
79
80 /**
81 * The next child node.
82 *
83 * @return the next child node.
84 */
85 public SymTabAST nextChild() {
86 return (SymTabAST)next();
87 }
88
89 /**
90 * Unsupported operation
91 */
92 public void remove() {
93 throw new UnsupportedOperationException();
94 }
95 }