1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.jxpath.ri.model;
18
19 /**
20 * Definition for an iterator for all kinds of Nodes.
21 *
22 * @author Dmitri Plotnikov
23 * @version $Revision: 652845 $ $Date: 2008-05-02 19:46:46 +0200 (Fr, 02 Mai 2008) $
24 */
25 public interface NodeIterator {
26
27 /**
28 * Get the current iterator position.
29 * @return int position
30 */
31 int getPosition();
32
33 /**
34 * Set the new current position.
35 * @param position the position to set
36 * @return <code>true</code> if there is a node at <code>position</code>.
37 */
38 boolean setPosition(int position);
39
40 /**
41 * Get the NodePointer at the current position.
42 * @return NodePointer
43 */
44 NodePointer getNodePointer();
45 }