001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.collections4;
018
019import java.util.Iterator;
020
021/**
022 * Defines an iterator that can be reset back to an initial state.
023 * <p>
024 * This interface allows an iterator to be repeatedly reused.
025 *
026 * @param <E> the type to iterate over
027 * @since 3.0
028 */
029public interface ResettableIterator<E> extends Iterator<E> {
030
031    /**
032     * Resets the iterator back to the position at which the iterator
033     * was created.
034     */
035    void reset();
036
037}