This class represents a file or form item that was received within a
multipart/form-data POST request.
After retrieving an instance of this class from a FileUpload instance (see #parseRequest(javax.servlet.http.HttpServletRequest) ), you may either request all contents of the file at once using get() or request an InputStream with getInputStream() and process the file without attempting to load it into memory, which may come handy with large files.
While this interface does not extend
javax.activation.DataSource per se (to avoid a seldom used
dependency), several of the defined methods are specifically defined with
the same signatures as methods in that interface. This allows an
implementation of this interface to also implement
javax.activation.DataSource with minimal additional work.
| Method Summary | |
|---|---|
| void |
Deletes the underlying storage for a file item, including deleting any associated temporary disk file. |
| byte[] |
Returns the contents of the file item as an array of bytes. |
| String |
Returns the content type passed by the browser or null if
not defined.
|
| String |
Returns the name of the field in the multipart form corresponding to this file item. |
| InputStream |
Returns an InputStream that can be used to retrieve the contents of the file. |
| String |
Returns the original filename in the client's filesystem, as provided by the browser (or other client software). |
| OutputStream |
Returns an OutputStream that can be used for storing the contents of the file. |
| long |
Returns the size of the file item. |
| String |
Returns the contents of the file item as a String, using the specified encoding. |
| String |
Returns the contents of the file item as a String, using the default character encoding. |
| boolean |
Determines whether or not a FileItem instance represents
a simple form field.
|
| boolean |
Provides a hint as to whether or not the file contents will be read from memory. |
| void |
Sets the field name used to reference this file item. |
| void |
Specifies whether or not a FileItem instance represents
a simple form field.
|
| void |
A convenience method to write an uploaded item to disk. |
public
byte[]
get
(
)
null if
not defined. public
boolean
isFormField
(
)
FileItem instance represents
a simple form field. public
boolean
isInMemory
(
)
public
void
setFormField
(
boolean
state
)
FileItem instance represents
a simple form field. This method is not guaranteed to succeed if called more than once for the same item. This allows a particular implementation to use, for example, file renaming, where possible, rather than copying all of the underlying data, thus gaining a significant performance benefit.
FileIteminstance is garbage collected, this method can be used to ensure that this is done at an earlier time, thus preserving system resources.