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.fileupload;
018
019import java.io.IOException;
020
021/**
022 * An iterator, as returned by
023 * {@link FileUploadBase#getItemIterator(RequestContext)}.
024 *
025 * @version $Id: FileItemIterator.java 1454691 2013-03-09 12:15:54Z simonetripodi $
026 */
027public interface FileItemIterator {
028
029    /**
030     * Returns, whether another instance of {@link FileItemStream}
031     * is available.
032     *
033     * @throws FileUploadException Parsing or processing the
034     *   file item failed.
035     * @throws IOException Reading the file item failed.
036     * @return True, if one or more additional file items
037     *   are available, otherwise false.
038     */
039    boolean hasNext() throws FileUploadException, IOException;
040
041    /**
042     * Returns the next available {@link FileItemStream}.
043     *
044     * @throws java.util.NoSuchElementException No more items are available. Use
045     * {@link #hasNext()} to prevent this exception.
046     * @throws FileUploadException Parsing or processing the
047     *   file item failed.
048     * @throws IOException Reading the file item failed.
049     * @return FileItemStream instance, which provides
050     *   access to the next file item.
051     */
052    FileItemStream next() throws FileUploadException, IOException;
053
054}