| org.apache.wicket.util.upload.FileItem
All known Subclasses: org.apache.wicket.util.upload.DiskFileItem,
| FileItem | | public interface FileItem extends IClusterable(Code) | |
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
org.apache.wicket.util.upload.FileUpload FileUpload instance, you may either request
all contents of the file at once using
FileItem.get() or request an
java.io.InputStream InputStream with
FileItem.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.
author:
Rafal Krzewski
author:
Sean Legassick
author:
Jason van Zyl
author:
Martin Cooper |
| Method Summary | |
| void | delete()
Deletes the underlying storage for a file item, including deleting any
associated temporary disk file. | | byte[] | get()
Returns the contents of the file item as an array of bytes. | | String | getContentType()
Returns the content type passed by the browser or null if
not defined. | | String | getFieldName()
Returns the name of the field in the multipart form corresponding to this
file item. | | InputStream | getInputStream()
Returns an
java.io.InputStream InputStream that can be used to
retrieve the contents of the file. | | String | getName()
Returns the original filename in the client's filesystem, as provided by
the browser (or other client software). | | OutputStream | getOutputStream()
Returns an
java.io.OutputStream OutputStream that can be used for
storing the contents of the file. | | long | getSize()
Returns the size of the file item. | | String | getString(String encoding)
Returns the contents of the file item as a String, using the specified
encoding. | | String | getString()
Returns the contents of the file item as a String, using the default
character encoding. | | boolean | isFormField()
Determines whether or not a FileItem instance represents a
simple form field. | | boolean | isInMemory()
Provides a hint as to whether or not the file contents will be read from
memory. | | void | setFieldName(String name)
Sets the field name used to reference this file item. | | void | setFormField(boolean state)
Specifies whether or not a FileItem instance represents a
simple form field. | | void | write(File file)
A convenience method to write an uploaded item to disk. |
| delete | | void delete()(Code) | | Deletes the underlying storage for a file item, including deleting any
associated temporary disk file. Although this storage will be deleted
automatically when the FileItem instance is garbage
collected, this method can be used to ensure that this is done at an
earlier time, thus preserving system resources.
|
| get | | byte[] get()(Code) | | Returns the contents of the file item as an array of bytes.
The contents of the file item as an array of bytes. |
| getContentType | | String getContentType()(Code) | | Returns the content type passed by the browser or null if
not defined.
The content type passed by the browser or null ifnot defined. |
| getFieldName | | String getFieldName()(Code) | | Returns the name of the field in the multipart form corresponding to this
file item.
The name of the form field. |
| getName | | String getName()(Code) | | Returns the original filename in the client's filesystem, as provided by
the browser (or other client software). In most cases, this will be the
base file name, without path information. However, some clients, such as
the Opera browser, do include path information.
The original filename in the client's filesystem. |
| getSize | | long getSize()(Code) | | Returns the size of the file item.
The size of the file item, in bytes. |
| getString | | String getString()(Code) | | Returns the contents of the file item as a String, using the default
character encoding. This method uses
FileItem.get() to retrieve the
contents of the item.
The contents of the item, as a string. |
| isFormField | | boolean isFormField()(Code) | | Determines whether or not a FileItem instance represents a
simple form field.
true if the instance represents a simple formfield; false if it represents an uploaded file. |
| isInMemory | | boolean isInMemory()(Code) | | Provides a hint as to whether or not the file contents will be read from
memory.
true if the file contents will be read frommemory; false otherwise. |
| setFieldName | | void setFieldName(String name)(Code) | | Sets the field name used to reference this file item.
Parameters:
name - The name of the form field. |
| setFormField | | void setFormField(boolean state)(Code) | | Specifies whether or not a FileItem instance represents a
simple form field.
Parameters:
state - true if the instance represents a simple formfield; false if it represents an uploaded file. |
| write | | void write(File file) throws Exception(Code) | | A convenience method to write an uploaded item to disk. The client code
is not concerned with whether or not the item is stored in memory, or on
disk in a temporary location. They just want to write the uploaded item
to a file.
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.
Parameters:
file - The File into which the uploaded item should bestored.
exception:
Exception - if an error occurs. |
|
|