Top Description Fields Constructors Methods
org.hibernate.hql.internal.ast.util

public Class ASTIterator

extends Object
implements Iterator
Class Inheritance
All Implemented Interfaces
java.util.Iterator
Imports
java.util.Iterator, .LinkedList, antlr.collections.AST
Depth first iteration of an ANTLR AST.
Author
josh

Field Summary

Modifier and TypeField and Description
private AST
next

private LinkedList<AST>
parents

Constructor Summary

AccessConstructor and Description
public
ASTIterator(AST
THe tree whose nodes are to be iterated
tree)

Constructs an Iterator for depth-first iteration of an AST

Method Summary

Modifier and TypeMethod and Description
private void
down()

public boolean
hasNext()

Implements java.util.Iterator.hasNext.

Returns true if the iteration has more elements.
public Object
next()

Implements java.util.Iterator.next.

Returns the next element in the iteration.
public AST

Returns:

The next node.
nextNode()

Get the next node to be returned from iteration.

private AST
pop()

private void
push(AST parent)

public void
remove()

Overrides default java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation).
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

nextback to summary
private AST next
parentsback to summary
private LinkedList<AST> parents

Constructor Detail

ASTIteratorback to summary
public ASTIterator(AST tree)

Constructs an Iterator for depth-first iteration of an AST

Parameters
tree:AST

THe tree whose nodes are to be iterated

Method Detail

downback to summary
private void down()
hasNextback to summary
public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations
@Override
nextback to summary
public Object next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:Object

the next element in the iteration

Annotations
@Override
nextNodeback to summary
public AST nextNode()

Get the next node to be returned from iteration.

Returns:AST

The next node.

popback to summary
private AST pop()
pushback to summary
private void push(AST parent)
removeback to summary
public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations
@Override