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.collections;
18
19 import java.util.Iterator;
20
21 /**
22 * Defines an iterator that can be reset back to an initial state.
23 * <p>
24 * This interface allows an iterator to be repeatedly reused.
25 *
26 * @param <E> the type to iterate over
27 * @since 3.0
28 * @version $Id: ResettableIterator.java 1361710 2012-07-15 15:00:21Z tn $
29 */
30 public interface ResettableIterator<E> extends Iterator<E> {
31
32 /**
33 * Resets the iterator back to the position at which the iterator
34 * was created.
35 */
36 public void reset();
37
38 }