KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > collections > OrderedMapIterator


1 /*
2  * Copyright 2001-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 /**
19  * Defines an iterator that operates over an ordered <code>Map</code>.
20  * <p>
21  * This iterator allows both forward and reverse iteration through the map.
22  *
23  * @since Commons Collections 3.0
24  * @version $Revision: 1.4 $ $Date: 2004/02/18 01:15:42 $
25  *
26  * @author Stephen Colebourne
27  */

28 public interface OrderedMapIterator extends MapIterator, OrderedIterator {
29     
30     /**
31      * Checks to see if there is a previous entry that can be iterated to.
32      *
33      * @return <code>true</code> if the iterator has a previous element
34      */

35     boolean hasPrevious();
36
37     /**
38      * Gets the previous <em>key</em> from the <code>Map</code>.
39      *
40      * @return the previous key in the iteration
41      * @throws java.util.NoSuchElementException if the iteration is finished
42      */

43     Object JavaDoc previous();
44
45 }
46
Popular Tags