libjava/org/w3c/dom/traversal/DocumentTraversal.java

   1 /*
   2  * Copyright (c) 2000 World Wide Web Consortium,
   3  * (Massachusetts Institute of Technology, Institut National de
   4  * Recherche en Informatique et en Automatique, Keio University). All
   5  * Rights Reserved. This program is distributed under the W3C's Software
   6  * Intellectual Property License. This program is distributed in the
   7  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
   8  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
   9  * PURPOSE.
  10  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
  11  */
  12
  13 package org.w3c.dom.traversal;
  14
  15 import org.w3c.dom.Node;
  16 import org.w3c.dom.DOMException;
  17
  18 /**
  19  * <code>DocumentTraversal</code> contains methods that create iterators and
  20  * tree-walkers to traverse a node and its children in document order (depth
  21  * first, pre-order traversal, which is equivalent to the order in which the
  22  * start tags occur in the text representation of the document). In DOMs
  23  * which support the Traversal feature, <code>DocumentTraversal</code> will
  24  * be implemented by the same objects that implement the Document interface.
  25  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113'>Document Object Model (DOM) Level 2 Traversal and Range Specification</a>.
  26  * @since DOM Level 2
  27  */
  28 public interface DocumentTraversal {
  29     /**
  30      * Create a new <code>NodeIterator</code> over the subtree rooted at the
  31      * specified node.
  32      * @param rootThe node which will be iterated together with its children.
  33      *   The iterator is initially positioned just before this node. The
  34      *   <code>whatToShow</code> flags and the filter, if any, are not
  35      *   considered when setting this position. The root must not be
  36      *   <code>null</code>.
  37      * @param whatToShowThis flag specifies which node types may appear in
  38      *   the logical view of the tree presented by the iterator. See the
  39      *   description of <code>NodeFilter</code> for the set of possible
  40      *   <code>SHOW_</code> values.These flags can be combined using
  41      *   <code>OR</code>.
  42      * @param filterThe <code>NodeFilter</code> to be used with this
  43      *   <code>TreeWalker</code>, or <code>null</code> to indicate no filter.
  44      * @param entityReferenceExpansionThe value of this flag determines
  45      *   whether entity reference nodes are expanded.
  46      * @return The newly created <code>NodeIterator</code>.
  47      * @exception DOMException
  48      *   NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is
  49      *   <code>null</code>.
  50      */
  51     public NodeIterator createNodeIterator(Node root,
  52                                            int whatToShow,
  53                                            NodeFilter filter,
  54                                            boolean entityReferenceExpansion)
  55                                            throws DOMException;
  56
  57     /**
  58      * Create a new <code>TreeWalker</code> over the subtree rooted at the
  59      * specified node.
  60      * @param rootThe node which will serve as the <code>root</code> for the
  61      *   <code>TreeWalker</code>. The <code>whatToShow</code> flags and the
  62      *   <code>NodeFilter</code> are not considered when setting this value;
  63      *   any node type will be accepted as the <code>root</code>. The
  64      *   <code>currentNode</code> of the <code>TreeWalker</code> is
  65      *   initialized to this node, whether or not it is visible. The
  66      *   <code>root</code> functions as a stopping point for traversal
  67      *   methods that look upward in the document structure, such as
  68      *   <code>parentNode</code> and nextNode. The <code>root</code> must
  69      *   not be <code>null</code>.
  70      * @param whatToShowThis flag specifies which node types may appear in
  71      *   the logical view of the tree presented by the tree-walker. See the
  72      *   description of <code>NodeFilter</code> for the set of possible
  73      *   SHOW_ values.These flags can be combined using <code>OR</code>.
  74      * @param filterThe <code>NodeFilter</code> to be used with this
  75      *   <code>TreeWalker</code>, or <code>null</code> to indicate no filter.
  76      * @param entityReferenceExpansionIf this flag is false, the contents of
  77      *   <code>EntityReference</code> nodes are not presented in the logical
  78      *   view.
  79      * @return The newly created <code>TreeWalker</code>.
  80      * @exception DOMException
  81      *    NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is
  82      *   <code>null</code>.
  83      */
  84     public TreeWalker createTreeWalker(Node root,
  85                                        int whatToShow,
  86                                        NodeFilter filter,
  87                                        boolean entityReferenceExpansion)
  88                                        throws DOMException;
  89
  90 }