OrderedIterator


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 org.apache.commons.collections;
17  
18  import java.util.Iterator  ;
19  
20  /**
21   * Defines an iterator that operates over a ordered collections.
22   * <p>
23   * This iterator allows both forward and reverse iteration through the collection.
24   *  
25   * @since Commons Collections 3.0
26   * @version $Revision: 1.4 $ $Date: 2004/02/18 01:15:42 $
27   *
28   * @author Stephen Colebourne
29   */
30  public interface OrderedIterator extends Iterator   {
31      
32      /**
33       * Checks to see if there is a previous entry that can be iterated to.
34       *
35       * @return <code>true</code> if the iterator has a previous element
36       */
37      boolean hasPrevious();
38  
39      /**
40       * Gets the previous element from the collection.
41       *
42       * @return the previous key in the iteration
43       * @throws java.util.NoSuchElementException if the iteration is finished
44       */
45      Object   previous();
46  
47  }
48

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags