- /*
- * Copyright 2001-2004 The Apache Software Foundation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
- package org.apache.commons.collections;
-
- /**
- * Defines an iterator that operates over an ordered <code>Map</code>.
- * <p>
- * This iterator allows both forward and reverse iteration through the map.
- *
- * @since Commons Collections 3.0
- * @version $Revision: 1.4 $ $Date: 2004/02/18 01:15:42 $
- *
- * @author Stephen Colebourne
- */
- public interface OrderedMapIterator extends MapIterator, OrderedIterator {
-
- /**
- * Checks to see if there is a previous entry that can be iterated to.
- *
- * @return <code>true</code> if the iterator has a previous element
- */
- boolean hasPrevious();
-
- /**
- * Gets the previous <em>key</em> from the <code>Map</code>.
- *
- * @return the previous key in the iteration
- * @throws java.util.NoSuchElementException if the iteration is finished
- */
- Object previous();
-
- }