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
18 package org.apache.commons.jxpath.ri.model;
19
20 /**
21 * Definition for an iterator for all kinds of Nodes.
22 */
23 public interface NodeIterator {
24
25 /**
26 * Gets the NodePointer at the current position.
27 *
28 * @return NodePointer
29 */
30 NodePointer getNodePointer();
31
32 /**
33 * Gets the current iterator position.
34 *
35 * @return int position
36 */
37 int getPosition();
38
39 /**
40 * Sets the new current position.
41 *
42 * @param position the position to set
43 * @return {@code true} if there is a node at {@code position}.
44 */
45 boolean setPosition(int position);
46 }