File	Doc	Category	Size	Date	Package
FileItem.java	API Doc	Apache Tomcat 6.0.14	7961	Fri Jul 20 04:20:36 BST 2007	org.apache.tomcat.util.http.fileupload

FileItem

Fields Summary

Constructors Summary

Methods Summary
public void	delete() 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.
public byte[]	get() Returns the contents of the file item as an array of bytes. return The contents of the file item as an array of bytes.
public java.lang.String	getContentType() Returns the content type passed by the browser or null if not defined. return The content type passed by the browser or null if not defined.
public java.lang.String	getFieldName() Returns the name of the field in the multipart form corresponding to this file item. return The name of the form field.
public java.io.InputStream	getInputStream() Returns an {@link java.io.InputStream InputStream} that can be used to retrieve the contents of the file. return An {@link java.io.InputStream InputStream} that can be used to retrieve the contents of the file. exception IOException if an error occurs.
public java.lang.String	getName() 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. return The original filename in the client's filesystem.
public java.io.OutputStream	getOutputStream() Returns an {@link java.io.OutputStream OutputStream} that can be used for storing the contents of the file. return An {@link java.io.OutputStream OutputStream} that can be used for storing the contensts of the file. exception IOException if an error occurs.
public long	getSize() Returns the size of the file item. return The size of the file item, in bytes.
public java.lang.String	getString(java.lang.String encoding) Returns the contents of the file item as a String, using the specified encoding. This method uses {@link #get()} to retrieve the contents of the item. param encoding The character encoding to use. return The contents of the item, as a string. exception UnsupportedEncodingException if the requested character encoding is not available.
public java.lang.String	getString() Returns the contents of the file item as a String, using the default character encoding. This method uses {@link #get()} to retrieve the contents of the item. return The contents of the item, as a string.
public boolean	isFormField() Determines whether or not a FileItem instance represents a simple form field. return true if the instance represents a simple form field; false if it represents an uploaded file.
public boolean	isInMemory() Provides a hint as to whether or not the file contents will be read from memory. return true if the file contents will be read from memory; false otherwise.
public void	setFieldName(java.lang.String name) Sets the field name used to reference this file item. param name The name of the form field.
public void	setFormField(boolean state) Specifies whether or not a FileItem instance represents a simple form field. param state true if the instance represents a simple form field; false if it represents an uploaded file.
public void	write(java.io.File file) 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. param file The File into which the uploaded item should be stored. exception Exception if an error occurs.