com.groupbyinc.common.apache.commons.collections4.OrderedIterator Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.collections4;
import java.util.Iterator;
/**
* Defines an iterator that operates over an ordered container. Subset of {@link java.util.ListIterator}.
*
* This iterator allows both forward and reverse iteration through the container.
*
* @param the type to iterate over
* @since 3.0
* @version $Id: OrderedIterator.java 1469004 2013-04-17 17:37:03Z tn $
*/
public interface OrderedIterator extends Iterator {
/**
* Checks to see if there is a previous element that can be iterated to.
*
* @return true if the iterator has a previous element
*/
boolean hasPrevious();
/**
* Gets the previous element from the container.
*
* @return the previous element in the iteration
* @throws java.util.NoSuchElementException if the iteration is finished
*/
E previous();
}