edu.illinois.cs.cogcomp.lbjava.IR

Class List.NodeListIterator

java.lang.Object

edu.illinois.cs.cogcomp.lbjava.IR.ASTNodeIterator

edu.illinois.cs.cogcomp.lbjava.IR.List.NodeListIterator

Direct Known Subclasses:

CatchList.CatchListIterator, ClassifierExpressionList.ClassifierExpressionListIterator, ConstantList.ConstantListIterator, DeclarationList.DeclarationListIterator, ExpressionList.ExpressionListIterator, ImportList.ImportListIterator, NameList.NameListIterator, StatementList.StatementListIterator, SwitchGroupList.SwitchGroupListIterator, SwitchLabelList.SwitchLabelListIterator

Enclosing class:

List

public class List.NodeListIterator
extends ASTNodeIterator

Used to iterate though the children of a list of AST nodes. The entire interface of java.util.ListIterator is exposed through this class.

Author:

Nick Rizzolo

Field Summary

Fields

Modifier and Type	Field and Description
protected ListIterator	I An iterator into list.

Fields inherited from class edu.illinois.cs.cogcomp.lbjava.IR.ASTNodeIterator

children, index

Constructor Summary

Constructors

Constructor and Description
NodeListIterator() Initializes I.

Method Summary

Modifier and Type	Method and Description
void	add(ASTNode n) Inserts the specified node into the list.
boolean	hasNext() Returns true if this list iterator has more elements when traversing the list in the forward direction.
boolean	hasPrevious() Returns true if this list iterator has more elements when traversing the list in the reverse direction.
ASTNode	next() Returns the next AST node in the list.
int	nextIndex() Returns the index of the node that would be returned by a subsequent call to next().
ASTNode	previous() Returns the previous element in the list.
int	previousIndex() Returns the index of the node that would be returned by a subsequent call to previous().
void	remove() Removes from the list the last element that was returned by next() or previous.
void	reset() Restarts the iterator.
void	set(ASTNode n) Replaces the last element returned by next() or previous() with the specified element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

I

protected ListIterator I

An iterator into list.

Constructor Detail

NodeListIterator

public NodeListIterator()

Initializes I.

Method Detail

add

public void add(ASTNode n)

Inserts the specified node into the list. The element is inserted immediately before the next element that would be returned by next(), if any, and after the next element that would be returned by previous(), if any. (If the list contains no elements, the new element becomes the sole element on the list.) The new element is inserted before the implicit cursor: a subsequent call to next() would be unaffected, and a subsequent call to previous() would return the new element. (This call increases by one the value that would be returned by a call to nextIndex or previousIndex.)

Parameters:

n - The node to add.

hasNext

public boolean hasNext()

Returns true if this list iterator has more elements when traversing the list in the forward direction.

Overrides:

hasNext in class ASTNodeIterator

Returns:

true if this list iterator has more elements when traversing the list in the forward direction.

hasPrevious

public boolean hasPrevious()

Returns true if this list iterator has more elements when traversing the list in the reverse direction.

Returns:

true if this list iterator has more elements when traversing the list in the reverse direction.

next

public ASTNode next()

Returns the next AST node in the list. This method may be called repeatedly to iterate through the list, or intermixed with calls to previous() to go back and forth. (Note that alternating calls to next() and previous() will return the same element repeatedly.)

Overrides:

next in class ASTNodeIterator

Returns:

The next AST node in the list.

nextIndex

public int nextIndex()

Returns the index of the node that would be returned by a subsequent call to next(). (Returns list size if the list iterator is at the end of the list.)

Returns:

The index of the element that would be returned by a subsequent call to next(), or list size if list iterator is at end of list.

previous

public ASTNode previous()

Returns the previous element in the list. This method may be called repeatedly to iterate through the list backwards, or intermixed with calls to next to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)

Returns:

The previous AST node in the list.

previousIndex

public int previousIndex()

Returns the index of the node that would be returned by a subsequent call to previous(). (Returns -1 if the list iterator is at the beginning of the list.)

Returns:

The index of the element that would be returned by a subsequent call to previous(), or -1 if list iterator is at the beginning of the list.

remove

public void remove()

Removes from the list the last element that was returned by next() or previous. This call can only be made once per call to next() or previous. It can be made only if add(ASTNode) has not been called after the last call to next() or previous.

reset

public void reset()

Restarts the iterator.

Overrides:

reset in class ASTNodeIterator

set

public void set(ASTNode n)

Replaces the last element returned by next() or previous() with the specified element. This call can be made only if neither remove() nor add(ASTNode) have been called after the last call to next() or previous().

Parameters:

n - The element with which to replace the last element returned by next() or previous().