001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.commons.jxpath.ri.model;
018    
019    /**
020     * Definition for an iterator for all kinds of Nodes.
021     *
022     * @author Dmitri Plotnikov
023     * @version $Revision: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $
024     */
025    public interface NodeIterator {
026    
027        /**
028         * Get the current iterator position.
029         * @return int position
030         */
031        int getPosition();
032    
033        /**
034         * Set the new current position.
035         * @param position the position to set
036         * @return <code>true</code> if there is a node at <code>position</code>.
037         */
038        boolean setPosition(int position);
039    
040        /**
041         * Get the NodePointer at the current position.
042         * @return NodePointer
043         */
044        NodePointer getNodePointer();
045    }