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
018package org.apache.commons.jxpath.ri.model;
019
020/**
021 * Definition for an iterator for all kinds of Nodes.
022 */
023public interface NodeIterator {
024
025    /**
026     * Gets the NodePointer at the current position.
027     *
028     * @return NodePointer
029     */
030    NodePointer getNodePointer();
031
032    /**
033     * Gets the current iterator position.
034     *
035     * @return int position
036     */
037    int getPosition();
038
039    /**
040     * Sets the new current position.
041     *
042     * @param position the position to set
043     * @return {@code true} if there is a node at {@code position}.
044     */
045    boolean setPosition(int position);
046}