01: /*
02: * Copyright 2001-2004 The Apache Software Foundation
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
25: *
26: * @author Stephen Colebourne
27: */
28: public interface OrderedMapIterator extends MapIterator,
29: OrderedIterator {
30:
31: /**
32: * Checks to see if there is a previous entry that can be iterated to.
33: *
34: * @return <code>true</code> if the iterator has a previous element
35: */
36: boolean hasPrevious();
37:
38: /**
39: * Gets the previous <em>key</em> from the <code>Map</code>.
40: *
41: * @return the previous key in the iteration
42: * @throws java.util.NoSuchElementException if the iteration is finished
43: */
44: Object previous();
45:
46: }
|