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

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