< prev index next >

jaxp/src/java.xml/share/classes/org/w3c/dom/traversal/DocumentTraversal.java

Print this page




  36  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
  37  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  38  * PURPOSE.
  39  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
  40  */
  41 
  42 package org.w3c.dom.traversal;
  43 
  44 import org.w3c.dom.Node;
  45 import org.w3c.dom.DOMException;
  46 
  47 /**
  48  * <code>DocumentTraversal</code> contains methods that create
  49  * <code>NodeIterators</code> and <code>TreeWalkers</code> to traverse a
  50  * node and its children in document order (depth first, pre-order
  51  * traversal, which is equivalent to the order in which the start tags occur
  52  * in the text representation of the document). In DOMs which support the
  53  * Traversal feature, <code>DocumentTraversal</code> will be implemented by
  54  * the same objects that implement the Document interface.
  55  * <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>.
  56  * @since 1.9, DOM Level 2
  57  */
  58 public interface DocumentTraversal {
  59     /**
  60      * Create a new <code>NodeIterator</code> over the subtree rooted at the
  61      * specified node.
  62      * @param root The node which will be iterated together with its
  63      *   children. The <code>NodeIterator</code> is initially positioned
  64      *   just before this node. The <code>whatToShow</code> flags and the
  65      *   filter, if any, are not considered when setting this position. The
  66      *   root must not be <code>null</code>.
  67      * @param whatToShow This flag specifies which node types may appear in
  68      *   the logical view of the tree presented by the
  69      *   <code>NodeIterator</code>. See the description of
  70      *   <code>NodeFilter</code> for the set of possible <code>SHOW_</code>
  71      *   values.These flags can be combined using <code>OR</code>.
  72      * @param filter The <code>NodeFilter</code> to be used with this
  73      *   <code>NodeIterator</code>, or <code>null</code> to indicate no
  74      *   filter.
  75      * @param entityReferenceExpansion The value of this flag determines
  76      *   whether entity reference nodes are expanded.




  36  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
  37  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  38  * PURPOSE.
  39  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
  40  */
  41 
  42 package org.w3c.dom.traversal;
  43 
  44 import org.w3c.dom.Node;
  45 import org.w3c.dom.DOMException;
  46 
  47 /**
  48  * <code>DocumentTraversal</code> contains methods that create
  49  * <code>NodeIterators</code> and <code>TreeWalkers</code> to traverse a
  50  * node and its children in document order (depth first, pre-order
  51  * traversal, which is equivalent to the order in which the start tags occur
  52  * in the text representation of the document). In DOMs which support the
  53  * Traversal feature, <code>DocumentTraversal</code> will be implemented by
  54  * the same objects that implement the Document interface.
  55  * <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>.
  56  * @since 9, DOM Level 2
  57  */
  58 public interface DocumentTraversal {
  59     /**
  60      * Create a new <code>NodeIterator</code> over the subtree rooted at the
  61      * specified node.
  62      * @param root The node which will be iterated together with its
  63      *   children. The <code>NodeIterator</code> is initially positioned
  64      *   just before this node. The <code>whatToShow</code> flags and the
  65      *   filter, if any, are not considered when setting this position. The
  66      *   root must not be <code>null</code>.
  67      * @param whatToShow This flag specifies which node types may appear in
  68      *   the logical view of the tree presented by the
  69      *   <code>NodeIterator</code>. See the description of
  70      *   <code>NodeFilter</code> for the set of possible <code>SHOW_</code>
  71      *   values.These flags can be combined using <code>OR</code>.
  72      * @param filter The <code>NodeFilter</code> to be used with this
  73      *   <code>NodeIterator</code>, or <code>null</code> to indicate no
  74      *   filter.
  75      * @param entityReferenceExpansion The value of this flag determines
  76      *   whether entity reference nodes are expanded.


< prev index next >