javax.swing.text

Class ElementIterator

Implemented Interfaces:
Cloneable

public class ElementIterator
extends Object
implements Cloneable

This class can be used to iterate over the Element tree of a Document or an Element. This iterator performs an "in-order" traversal -- first it visits a node, then each of the node's children in order. No locking is performed during the iteration; that is up to the caller.

Constructor Summary

ElementIterator(Document document)
Create a new ElementIterator to iterate over the given document.
ElementIterator(Element root)
Create a new ElementIterator to iterate over the given document.

Method Summary

Object
clone()
Returns a new ElementIterator which is a clone of this ElementIterator.
Element
current()
Returns the current element.
int
depth()
Returns the depth to which we have descended in the tree.
Element
first()
Returns the first element in the tree.
Element
next()
Advance the iterator and return the next element of the tree, performing an "in-order" traversal.
Element
previous()
Returns the previous item.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ElementIterator

public ElementIterator(Document document)
Create a new ElementIterator to iterate over the given document.
Parameters:
document - the Document over which we iterate

ElementIterator

public ElementIterator(Element root)
Create a new ElementIterator to iterate over the given document.
Parameters:
root - the Document over which we iterate

Method Details

clone

public Object clone()
Returns a new ElementIterator which is a clone of this ElementIterator.
Overrides:
clone in interface Object

current

public Element current()
Returns the current element.

depth

public int depth()
Returns the depth to which we have descended in the tree.

first

public Element first()
Returns the first element in the tree.

next

public Element next()
Advance the iterator and return the next element of the tree, performing an "in-order" traversal.

previous

public Element previous()
Returns the previous item. Does not modify the iterator state.

ElementIterator.java -- Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.