1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one or more 3 * contributor license agreements. See the NOTICE file distributed with 4 * this work for additional information regarding copyright ownership. 5 * The ASF licenses this file to You under the Apache License, Version 2.0 6 * (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 package org.apache.commons.fileupload; 18 19 import java.io.IOException; 20 21 /** 22 * An iterator, as returned by 23 * {@link FileUploadBase#getItemIterator(RequestContext)}. 24 */ 25 public interface FileItemIterator { 26 27 /** 28 * Returns, whether another instance of {@link FileItemStream} 29 * is available. 30 * 31 * @throws FileUploadException Parsing or processing the 32 * file item failed. 33 * @throws IOException Reading the file item failed. 34 * @return True, if one or more additional file items 35 * are available, otherwise false. 36 */ 37 boolean hasNext() throws FileUploadException, IOException; 38 39 /** 40 * Returns the next available {@link FileItemStream}. 41 * 42 * @throws java.util.NoSuchElementException No more items are available. Use 43 * {@link #hasNext()} to prevent this exception. 44 * @throws FileUploadException Parsing or processing the 45 * file item failed. 46 * @throws IOException Reading the file item failed. 47 * @return FileItemStream instance, which provides 48 * access to the next file item. 49 */ 50 FileItemStream next() throws FileUploadException, IOException; 51 52 }