View Javadoc

1   /*
2    *  Copyright 2003-2004 The Apache Software Foundation
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  package net.sf.collections15;
17  
18  import java.util.Iterator;
19  
20  /***
21   * Defines an iterator that can be reset back to an initial state.
22   * <p/>
23   * This interface allows an iterator to be repeatedly reused.
24   *
25   * @author Stephen Colebourne
26   * @version $Revision: 1.2 $ $Date: 2004/10/17 01:02:42 $
27   * @since Commons Collections 3.0
28   */
29  public interface ResettableIterator <E> extends Iterator<E>
30  {
31  
32      /***
33       * Resets the iterator back to the position at which the iterator was
34       * created.
35       */
36      public void reset();
37  
38  }