286N/A/*
286N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
286N/A *
286N/A * This code is free software; you can redistribute it and/or modify it
286N/A * under the terms of the GNU General Public License version 2 only, as
286N/A * published by the Free Software Foundation. Oracle designates this
286N/A * particular file as subject to the "Classpath" exception as provided
286N/A * by Oracle in the LICENSE file that accompanied this code.
286N/A *
286N/A * This code is distributed in the hope that it will be useful, but WITHOUT
286N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
286N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
286N/A * version 2 for more details (a copy is included in the LICENSE file that
286N/A * accompanied this code).
286N/A *
286N/A * You should have received a copy of the GNU General Public License version
286N/A * 2 along with this work; if not, write to the Free Software Foundation,
286N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
286N/A *
286N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
286N/A * or visit www.oracle.com if you need additional information or have any
286N/A * questions.
286N/A */
286N/A
286N/A/*
286N/A * This file is available under and governed by the GNU General Public
286N/A * License version 2 only, as published by the Free Software Foundation.
286N/A * However, the following notice accompanied the original version of this
286N/A * file and, per its terms, should not be removed:
286N/A *
286N/A * Copyright (c) 2000 World Wide Web Consortium,
286N/A * (Massachusetts Institute of Technology, Institut National de
286N/A * Recherche en Informatique et en Automatique, Keio University). All
286N/A * Rights Reserved. This program is distributed under the W3C's Software
286N/A * Intellectual Property License. This program is distributed in the
286N/A * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
286N/A * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
286N/A * PURPOSE.
286N/A * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
286N/A */
286N/A
286N/Apackage org.w3c.dom.traversal;
286N/A
286N/Aimport org.w3c.dom.Node;
286N/Aimport org.w3c.dom.DOMException;
286N/A
286N/A/**
286N/A * <code>DocumentTraversal</code> contains methods that create
286N/A * <code>NodeIterators</code> and <code>TreeWalkers</code> to traverse a
286N/A * node and its children in document order (depth first, pre-order
286N/A * traversal, which is equivalent to the order in which the start tags occur
286N/A * in the text representation of the document). In DOMs which support the
286N/A * Traversal feature, <code>DocumentTraversal</code> will be implemented by
286N/A * the same objects that implement the Document interface.
286N/A * <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>.
286N/A * @since DOM Level 2
286N/A */
286N/Apublic interface DocumentTraversal {
286N/A /**
286N/A * Create a new <code>NodeIterator</code> over the subtree rooted at the
286N/A * specified node.
286N/A * @param root The node which will be iterated together with its
286N/A * children. The <code>NodeIterator</code> is initially positioned
286N/A * just before this node. The <code>whatToShow</code> flags and the
286N/A * filter, if any, are not considered when setting this position. The
286N/A * root must not be <code>null</code>.
286N/A * @param whatToShow This flag specifies which node types may appear in
286N/A * the logical view of the tree presented by the
286N/A * <code>NodeIterator</code>. See the description of
286N/A * <code>NodeFilter</code> for the set of possible <code>SHOW_</code>
286N/A * values.These flags can be combined using <code>OR</code>.
286N/A * @param filter The <code>NodeFilter</code> to be used with this
286N/A * <code>NodeIterator</code>, or <code>null</code> to indicate no
286N/A * filter.
286N/A * @param entityReferenceExpansion The value of this flag determines
286N/A * whether entity reference nodes are expanded.
286N/A * @return The newly created <code>NodeIterator</code>.
286N/A * @exception DOMException
286N/A * NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is
286N/A * <code>null</code>.
286N/A */
286N/A public NodeIterator createNodeIterator(Node root,
286N/A int whatToShow,
286N/A NodeFilter filter,
286N/A boolean entityReferenceExpansion)
286N/A throws DOMException;
286N/A
286N/A /**
286N/A * Create a new <code>TreeWalker</code> over the subtree rooted at the
286N/A * specified node.
286N/A * @param root The node which will serve as the <code>root</code> for the
286N/A * <code>TreeWalker</code>. The <code>whatToShow</code> flags and the
286N/A * <code>NodeFilter</code> are not considered when setting this value;
286N/A * any node type will be accepted as the <code>root</code>. The
286N/A * <code>currentNode</code> of the <code>TreeWalker</code> is
286N/A * initialized to this node, whether or not it is visible. The
286N/A * <code>root</code> functions as a stopping point for traversal
286N/A * methods that look upward in the document structure, such as
286N/A * <code>parentNode</code> and nextNode. The <code>root</code> must
286N/A * not be <code>null</code>.
286N/A * @param whatToShow This flag specifies which node types may appear in
286N/A * the logical view of the tree presented by the
286N/A * <code>TreeWalker</code>. See the description of
286N/A * <code>NodeFilter</code> for the set of possible <code>SHOW_</code>
286N/A * values.These flags can be combined using <code>OR</code>.
286N/A * @param filter The <code>NodeFilter</code> to be used with this
286N/A * <code>TreeWalker</code>, or <code>null</code> to indicate no filter.
286N/A * @param entityReferenceExpansion If this flag is false, the contents of
286N/A * <code>EntityReference</code> nodes are not presented in the logical
286N/A * view.
286N/A * @return The newly created <code>TreeWalker</code>.
286N/A * @exception DOMException
286N/A * NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is
286N/A * <code>null</code>.
286N/A */
286N/A public TreeWalker createTreeWalker(Node root,
286N/A int whatToShow,
286N/A NodeFilter filter,
286N/A boolean entityReferenceExpansion)
286N/A throws DOMException;
286N/A
286N/A}