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