Package org.apache.commons.fileupload

Class FileUploadBase.FileItemIteratorImpl

java.lang.Object

org.apache.commons.fileupload.FileUploadBase.FileItemIteratorImpl

All Implemented Interfaces:

FileItemIterator

Enclosing class:

FileUploadBase

private class FileUploadBase.FileItemIteratorImpl
extends Object
implements FileItemIterator

The iterator, which is returned by FileUploadBase.getItemIterator(RequestContext).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	FileUploadBase.FileItemIteratorImpl.FileItemStreamImpl	Default implementation of FileItemStream.

Field Summary

Fields

Modifier and Type	Field	Description
private final byte[]	boundary	The boundary, which separates the various parts.
private String	currentFieldName	The current items field name.
private FileUploadBase.FileItemIteratorImpl.FileItemStreamImpl	currentItem	The item, which we currently process.
private boolean	eof	Whether we have seen the end of the file.
private boolean	itemValid	Whether the current item may still be read.
private final MultipartStream	multi	The multi part stream to process.
private final boolean	multipartRelated	Is this a multipart/related Request.
private final MultipartStream.ProgressNotifier	notifier	The notifier, which used for triggering the ProgressListener.
private boolean	skipPreamble	Whether we are currently skipping the preamble.

Constructor Summary

Constructors

Constructor	Description
FileItemIteratorImpl(RequestContext ctx)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
private boolean	findNextItem()	Called for finding the next item, if any.
private long	getContentLength(FileItemHeaders headers)
boolean	hasNext()	Returns, whether another instance of FileItemStream is available.
FileItemStream	next()	Returns the next available FileItemStream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

multi

private final MultipartStream multi

The multi part stream to process.

notifier

private final MultipartStream.ProgressNotifier notifier

The notifier, which used for triggering the ProgressListener.

boundary

private final byte[] boundary

The boundary, which separates the various parts.

currentItem

private FileUploadBase.FileItemIteratorImpl.FileItemStreamImpl currentItem

The item, which we currently process.

currentFieldName

private String currentFieldName

The current items field name.

skipPreamble

private boolean skipPreamble

Whether we are currently skipping the preamble.

itemValid

private boolean itemValid

Whether the current item may still be read.

eof

private boolean eof

Whether we have seen the end of the file.

multipartRelated

private final boolean multipartRelated

Is this a multipart/related Request.

Constructor Details

FileItemIteratorImpl

FileItemIteratorImpl(RequestContext ctx)
              throws FileUploadException,
IOException

Creates a new instance.

Parameters:

ctx - The request context.

Throws:

FileUploadException - An error occurred while parsing the request.

IOException - An I/O error occurred.

Method Details

findNextItem

private boolean findNextItem()
                      throws IOException

Called for finding the next item, if any.

Returns:

True, if an next item was found, otherwise false.

Throws:

IOException - An I/O error occurred.

getContentLength

private long getContentLength(FileItemHeaders headers)

hasNext

public boolean hasNext()
                throws FileUploadException,
IOException

Returns, whether another instance of FileItemStream is available.

Specified by:

hasNext in interface FileItemIterator

Returns:

True, if one or more additional file items are available, otherwise false.

Throws:

FileUploadException - Parsing or processing the file item failed.

IOException - Reading the file item failed.

next

public FileItemStream next()
                    throws FileUploadException,
IOException

Returns the next available FileItemStream.

Specified by:

next in interface FileItemIterator

Returns:

FileItemStream instance, which provides access to the next file item.

Throws:

NoSuchElementException - No more items are available. Use hasNext() to prevent this exception.

FileUploadException - Parsing or processing the file item failed.

IOException - Reading the file item failed.