01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: * Returns, whether another instance of {@link FileItemStream}
28: * is available.
29: * @throws FileUploadException Parsing or processing the
30: * file item failed.
31: * @throws IOException Reading the file item failed.
32: * @return True, if one or more additional file items
33: * are available, otherwise false.
34: */
35: boolean hasNext() throws FileUploadException, IOException;
36:
37: /**
38: * Returns the next available {@link FileItemStream}.
39: * @throws java.util.NoSuchElementException No more items are available. Use
40: * {@link #hasNext()} to prevent this exception.
41: * @throws FileUploadException Parsing or processing the
42: * file item failed.
43: * @throws IOException Reading the file item failed.
44: * @return FileItemStream instance, which provides
45: * access to the next file item.
46: */
47: FileItemStream next() throws FileUploadException, IOException;
48: }
|