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 */
025public interface FileItemIterator {
026
027    /**
028     * Returns, whether another instance of {@link FileItemStream}
029     * is available.
030     *
031     * @throws FileUploadException Parsing or processing the
032     *   file item failed.
033     * @throws IOException Reading the file item failed.
034     * @return True, if one or more additional file items
035     *   are available, otherwise false.
036     */
037    boolean hasNext() throws FileUploadException, IOException;
038
039    /**
040     * Returns the next available {@link FileItemStream}.
041     *
042     * @throws java.util.NoSuchElementException No more items are available. Use
043     * {@link #hasNext()} to prevent this exception.
044     * @throws FileUploadException Parsing or processing the
045     *   file item failed.
046     * @throws IOException Reading the file item failed.
047     * @return FileItemStream instance, which provides
048     *   access to the next file item.
049     */
050    FileItemStream next() throws FileUploadException, IOException;
051
052}