Top Description Fields Constructors Methods

org.jdom

pack-priv Class DescendantIterator

Class Inheritance

extends Object
implements Iterator

java.lang.Object
org.jdom.DescendantIterator

All Implemented Interfaces

java.util.Iterator

Imports

java.util.*, org.jdom.Content, .Element, .Parent

Traverse all a parent's descendants (all children at any level below the parent).

Authors: Bradley S. Huffman, Jason Hunter
Version: $Revision: 1.6 $, $Date: 2007/11/10 05:28:58 $

Field Summary

Modifier and Type	Field and Description
private static final String	CVS_ID
private Iterator<E>	iterator
private Iterator<E>	nextIterator
private List<E>	stack

Constructor Summary

Access	Constructor and Description
pack-priv	DescendantIterator(Parent document or element whose descendants will be iterated parent) Iterator for the descendants of the supplied object.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true is the iterator has more descendants hasNext() Implements java.util.Iterator.hasNext. Returns true> if the iteration has more `Content` descendants.
public Object	Returns: the next descendant next() Implements java.util.Iterator.next. Returns the next `Content` descendant.
private Iterator<E>	pop()
private void	push(Iterator<E> itr)
public void	remove() Overrides default java.util.Iterator.remove. Detaches the last `org.jdom.Content` returned by the last call to next from it's parent Note this does not affect iteration and all children, siblings, and any node following the removed node (in document order) will be visited.
private boolean	stackHasAnyNext()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CVS_ID	back to summary
private static final String CVS_ID

iterator	back to summary
private Iterator<E> iterator

nextIterator	back to summary
private Iterator<E> nextIterator

stack	back to summary
private List<E> stack

Constructor Detail

DescendantIterator	back to summary
pack-priv DescendantIterator(Parent parent) Iterator for the descendants of the supplied object. Parameters parent:Parent document or element whose descendants will be iterated

DescendantIterator

back to summary

pack-priv DescendantIterator(Parent parent)

Iterator for the descendants of the supplied object.

Parameters

parent:Parent: document or element whose descendants will be iterated

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Returns true> if the iteration has more `Content` descendants. Returns:boolean true is the iterator has more descendants

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Returns true> if the iteration has more Content descendants.

Returns:boolean: true is the iterator has more descendants

next back to summary

next	back to summary
public Object next() Implements java.util.Iterator.next. Returns the next `Content` descendant. Returns:Object the next descendant

public Object next()

Implements java.util.Iterator.next.

Returns the next Content descendant.

Returns:Object: the next descendant

pop	back to summary
private Iterator<E> pop()

push	back to summary
private void push(Iterator<E> itr)

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Detaches the last `org.jdom.Content` returned by the last call to next from it's parent Note this does not affect iteration and all children, siblings, and any node following the removed node (in document order) will be visited.

public void remove()

Overrides default java.util.Iterator.remove.

Detaches the last org.jdom.Content returned by the last call to next from it's parent

Note

this does not affect iteration and all children, siblings, and any node following the removed node (in document order) will be visited.

stackHasAnyNext	back to summary
private boolean stackHasAnyNext()