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 *      https://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 */
017
018package org.apache.commons.collections4;
019
020import java.util.Iterator;
021
022/**
023 * Defines an iterator that can be reset back to an initial state.
024 * <p>
025 * This interface allows an iterator to be repeatedly reused.
026 * </p>
027 *
028 * @param <E> The type of elements returned by this iterator.
029 * @since 3.0
030 */
031public interface ResettableIterator<E> extends Iterator<E> {
032
033    /**
034     * Resets the iterator back to the position at which the iterator was created.
035     */
036    void reset();
037}