gnu.xml.dom
Class DomNodeIterator
- NodeIterator, TreeWalker
Node iterator and tree walker.
clone , equals , extends Object> getClass , finalize , hashCode , notify , notifyAll , toString , wait , wait , wait |
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.
- detach in interface NodeIterator
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.
- getExpandEntityReferences in interface NodeIterator
- getExpandEntityReferences 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.
- getWhatToShow in interface NodeIterator
- getWhatToShow 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.
- nextNode in interface NodeIterator
- nextNode in interface TreeWalker
- The next
Node
in the set being iterated over, or
null
if there are no more members in that set.
DOMException
- INVALID_STATE_ERR: Raised if this method is called after the
detach
method was invoked.
previousNode
public Node previousNode()
throws DOMException
Returns the previous node in the set and moves the position of the
NodeIterator
backwards in the set.
- previousNode in interface NodeIterator
- previousNode in interface TreeWalker
- The previous
Node
in the set being iterated over,
or null
if there are no more members in that set.
DOMException
- INVALID_STATE_ERR: Raised if this method is called after the
detach
method was invoked.
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.