+++ /dev/null
-/*\r
- * Copyright (c) 2000 World Wide Web Consortium,\r
- * (Massachusetts Institute of Technology, Institut National de\r
- * Recherche en Informatique et en Automatique, Keio University). All\r
- * Rights Reserved. This program is distributed under the W3C's Software\r
- * Intellectual Property License. This program is distributed in the\r
- * hope that it will be useful, but WITHOUT ANY WARRANTY; without even\r
- * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR\r
- * PURPOSE.\r
- * See W3C License http://www.w3.org/Consortium/Legal/ for more details.\r
- */\r
-\r
-package org.w3c.dom.traversal;\r
-\r
-import org.w3c.dom.Node;\r
-import org.w3c.dom.DOMException;\r
-\r
-/**\r
- * <code>Iterators</code> are used to step through a set of nodes, e.g. the \r
- * set of nodes in a <code>NodeList</code>, the document subtree governed by \r
- * a particular <code>Node</code>, the results of a query, or any other set \r
- * of nodes. The set of nodes to be iterated is determined by the \r
- * implementation of the <code>NodeIterator</code>. DOM Level 2 specifies a \r
- * single <code>NodeIterator</code> implementation for document-order \r
- * traversal of a document subtree. Instances of these iterators are created \r
- * by calling <code>DocumentTraversal</code>\r
- * <code>.createNodeIterator()</code>.\r
- * <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
- * @since DOM Level 2\r
- */\r
-public interface NodeIterator {\r
- /**\r
- * The root node of the <code>NodeIterator</code>, as specified when it \r
- * was created.\r
- */\r
- public Node getRoot();\r
-\r
- /**\r
- * This attribute determines which node types are presented via the \r
- * iterator. The available set of constants is defined in the \r
- * <code>NodeFilter</code> interface. Nodes not accepted by \r
- * <code>whatToShow</code> will be skipped, but their children may still \r
- * be considered. Note that this skip takes precedence over the filter, \r
- * if any. \r
- */\r
- public int getWhatToShow();\r
-\r
- /**\r
- * The <code>NodeFilter</code> used to screen nodes.\r
- */\r
- public NodeFilter getFilter();\r
-\r
- /**\r
- * The value of this flag determines whether the children of entity \r
- * reference nodes are visible to the iterator. If false, they and \r
- * their descendants will be rejected. Note that this rejection takes \r
- * precedence over <code>whatToShow</code> and the filter. Also note \r
- * that this is currently the only situation where \r
- * <code>NodeIterators</code> may reject a complete subtree rather than \r
- * skipping individual nodes. \r
- * <br>\r
- * <br> To produce a view of the document that has entity references \r
- * expanded and does not expose the entity reference node itself, use \r
- * the <code>whatToShow</code> flags to hide the entity reference node \r
- * and set <code>expandEntityReferences</code> to true when creating the \r
- * iterator. To produce a view of the document that has entity reference \r
- * nodes but no entity expansion, use the <code>whatToShow</code> flags \r
- * to show the entity reference node and set \r
- * <code>expandEntityReferences</code> to false.\r
- */\r
- public boolean getExpandEntityReferences();\r
-\r
- /**\r
- * Returns the next node in the set and advances the position of the \r
- * iterator in the set. After a <code>NodeIterator</code> is created, \r
- * the first call to <code>nextNode()</code> returns the first node in \r
- * the set.\r
- * @return The next <code>Node</code> in the set being iterated over, or \r
- * <code>null</code> if there are no more members in that set.\r
- * @exception DOMException\r
- * INVALID_STATE_ERR: Raised if this method is called after the \r
- * <code>detach</code> method was invoked.\r
- */\r
- public Node nextNode()\r
- throws DOMException;\r
-\r
- /**\r
- * Returns the previous node in the set and moves the position of the \r
- * <code>NodeIterator</code> backwards in the set.\r
- * @return The previous <code>Node</code> in the set being iterated over, \r
- * or <code>null</code> if there are no more members in that set. \r
- * @exception DOMException\r
- * INVALID_STATE_ERR: Raised if this method is called after the \r
- * <code>detach</code> method was invoked.\r
- */\r
- public Node previousNode()\r
- throws DOMException;\r
-\r
- /**\r
- * Detaches the <code>NodeIterator</code> from the set which it iterated \r
- * over, releasing any computational resources and placing the iterator \r
- * in the INVALID state. After <code>detach</code> has been invoked, \r
- * calls to <code>nextNode</code> or <code>previousNode</code> will \r
- * raise the exception INVALID_STATE_ERR.\r
- */\r
- public void detach();\r
-\r
-}\r
projects / msp430-gcc.git / blobdiff