Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

gnu.xml.dom

Class DomNodeIterator

Implemented Interfaces:
NodeIterator, TreeWalker
public class DomNodeIterator
extends Object
implements NodeIterator, TreeWalker
Node iterator and tree walker.

Constructor Summary

DomNodeIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion, boolean walk)

Method Summary

void
detach()
Detaches the NodeIterator from the set which it iterated over, releasing any computational resources and placing the NodeIterator in the INVALID state.
Node
firstChild()
Node
getCurrentNode()
boolean
getExpandEntityReferences()
The value of this flag determines whether the children of entity reference nodes are visible to the NodeIterator.
NodeFilter
getFilter()
The NodeFilter used to screen nodes.
Node
getRoot()
The root node of the NodeIterator, as specified when it was created.
int
getWhatToShow()
This attribute determines which node types are presented via the NodeIterator.
Node
lastChild()
Node
nextNode()
Returns the next node in the set and advances the position of the NodeIterator in the set.
Node
nextSibling()
Node
parentNode()
Node
previousNode()
Returns the previous node in the set and moves the position of the NodeIterator backwards in the set.
Node
previousSibling()
void
setCurrentNode(Node current)

Methods inherited from class java.lang.Object

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

Constructor Details

DomNodeIterator

public DomNodeIterator(Node root,
                       int whatToShow,
                       NodeFilter filter,
                       boolean entityReferenceExpansion,
                       boolean walk)

Method Details

detach

public void detach()
Detaches the NodeIterator from the set which it iterated over, releasing any computational resources and placing the NodeIterator in the INVALID state. After detach has been invoked, calls to nextNode or previousNode will raise the exception INVALID_STATE_ERR.
Specified by:
detach in interface NodeIterator

firstChild

public Node firstChild()
Specified by:
firstChild in interface TreeWalker

getCurrentNode

public Node getCurrentNode()
Specified by:
getCurrentNode in interface TreeWalker

getExpandEntityReferences

public boolean getExpandEntityReferences()
The value of this flag determines whether the children of entity reference nodes are visible to the NodeIterator. If false, these children and their descendants will be rejected. Note that this rejection takes precedence over whatToShow and the filter. Also note that this is currently the only situation where NodeIterators may reject a complete subtree rather than skipping individual nodes.

To produce a view of the document that has entity references expanded and does not expose the entity reference node itself, use the whatToShow flags to hide the entity reference node and set expandEntityReferences to true when creating the NodeIterator. To produce a view of the document that has entity reference nodes but no entity expansion, use the whatToShow flags to show the entity reference node and set expandEntityReferences to false.
Specified by:
getExpandEntityReferences in interface NodeIterator
getExpandEntityReferences in interface TreeWalker

getFilter

public NodeFilter getFilter()
The NodeFilter used to screen nodes.
Specified by:
getFilter in interface NodeIterator
getFilter in interface TreeWalker

getRoot

public Node getRoot()
The root node of the NodeIterator, as specified when it was created.
Specified by:
getRoot in interface NodeIterator
getRoot in interface TreeWalker

getWhatToShow

public int getWhatToShow()
This attribute determines which node types are presented via the NodeIterator. The available set of constants is defined in the NodeFilter interface. Nodes not accepted by whatToShow will be skipped, but their children may still be considered. Note that this skip takes precedence over the filter, if any.
Specified by:
getWhatToShow in interface NodeIterator
getWhatToShow in interface TreeWalker

lastChild

public Node lastChild()
Specified by:
lastChild in interface TreeWalker

nextNode

public Node nextNode()
            throws DOMException
Returns the next node in the set and advances the position of the NodeIterator in the set. After a NodeIterator is created, the first call to nextNode() returns the first node in the set.
Specified by:
nextNode in interface NodeIterator
nextNode in interface TreeWalker
Returns:
The next Node in the set being iterated over, or null if there are no more members in that set.
Throws:
DOMException - INVALID_STATE_ERR: Raised if this method is called after the detach method was invoked.

nextSibling

public Node nextSibling()
Specified by:
nextSibling in interface TreeWalker

parentNode

public Node parentNode()
Specified by:
parentNode in interface TreeWalker

previousNode

public Node previousNode()
            throws DOMException
Returns the previous node in the set and moves the position of the NodeIterator backwards in the set.
Specified by:
previousNode in interface NodeIterator
previousNode in interface TreeWalker
Returns:
The previous Node in the set being iterated over, or null if there are no more members in that set.
Throws:
DOMException - INVALID_STATE_ERR: Raised if this method is called after the detach method was invoked.

previousSibling

public Node previousSibling()
Specified by:
previousSibling in interface TreeWalker

setCurrentNode

public void setCurrentNode(Node current)
            throws DOMException
Specified by:
setCurrentNode in interface TreeWalker
DomNodeIterator.java -- Copyright (C) 2004 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.

Overview Package Class Use Source Tree Index Deprecated About