public static class ApacheMultipartParser.AutoFileItem extends java.lang.Object implements FileItem
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
DEFAULT_CHARSET
Default content charset to be used when no explicit charset parameter is provided by the sender.
|
| Constructor and Description |
|---|
AutoFileItem(FileItemStream stream) |
| Modifier and Type | Method and Description |
|---|---|
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 as an array of bytes.
|
java.lang.String |
getCharSet()
Returns the content charset passed by the agent or
null if not defined. |
java.lang.String |
getContentType()
Returns the content type passed by the agent or
null if not defined. |
java.lang.String |
getFieldName()
Returns the name of the field in the multipart form corresponding to this file item.
|
FileItemHeaders |
getHeaders()
Returns the file item headers.
|
java.io.InputStream |
getInputStream()
Returns an
InputStream that can be used to retrieve the contents of the file. |
java.lang.String |
getName()
Returns the original filename in the client's filesystem.
|
java.io.OutputStream |
getOutputStream()
Returns an
OutputStream that can be used for storing the contents of the file. |
long |
getSize()
Returns the size of the file.
|
java.io.File |
getStoreLocation()
Returns the
File object for the FileItem's data's temporary location on the
disk. |
java.lang.String |
getString()
Returns the contents of the file as a String, using the default character encoding.
|
java.lang.String |
getString(java.lang.String charset)
Returns the contents of the file as a String, using the specified encoding.
|
protected java.io.File |
getTempFile()
Creates and returns a
File representing a uniquely named temporary file in the
configured repository path. |
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(java.lang.String fieldName)
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 |
setHeaders(FileItemHeaders pHeaders)
Sets the file item headers.
|
java.lang.String |
toString() |
void |
write(java.io.File file)
A convenience method to write an uploaded item to disk.
|
public static final java.lang.String DEFAULT_CHARSET
public AutoFileItem(FileItemStream stream)
public java.io.InputStream getInputStream()
throws java.io.IOException
InputStream that can be used to retrieve the contents of the file.getInputStream in interface FileItemInputStream that can be used to retrieve the contents of the file.java.io.IOException - if an error occurs.public java.lang.String getContentType()
null if not defined.getContentType in interface FileItemnull if not defined.public java.lang.String getCharSet()
null if not defined.null if not defined.public java.lang.String getName()
public boolean isInMemory()
isInMemory in interface FileItemtrue if the file contents will be read from memory; false otherwise.public long getSize()
public byte[] get()
public java.lang.String getString(java.lang.String charset)
throws java.io.UnsupportedEncodingException
get()
to retrieve the contents of the file.public java.lang.String getString()
get() to retrieve the contents of the file.
public void write(java.io.File file)
throws java.lang.Exception
This implementation first attempts to rename the uploaded item to the specified destination file, if the item was originally written to disk. Otherwise, the data will be copied to the specified file.
This method is only guaranteed to work once, the first time it is invoked for a particular item. This is because, in the event that the method renames a temporary file, that file will no longer be available to copy or rename again at a later time.
public void delete()
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 java.lang.String getFieldName()
getFieldName in interface FileItemsetFieldName(java.lang.String)public void setFieldName(java.lang.String fieldName)
setFieldName in interface FileItemfieldName - The name of the form field.getFieldName()public boolean isFormField()
FileItem instance represents a simple form field.isFormField in interface FileItemtrue if the instance represents a simple form field; false if it represents
an uploaded file.setFormField(boolean)public void setFormField(boolean state)
FileItem instance represents a simple form field.setFormField in interface FileItemstate - true if the instance represents a simple form field; false if it
represents an uploaded file.isFormField()public java.io.OutputStream getOutputStream()
throws java.io.IOException
OutputStream that can be used for storing the contents of the file.getOutputStream in interface FileItemOutputStream that can be used for storing the contents of the file.java.io.IOException - if an error occurs.public java.io.File getStoreLocation()
File object for the FileItem's data's temporary location on the
disk. Note that for FileItems that have their data stored in memory, this method will return
null. When handling large files, you can use File.renameTo(java.io.File) to move
the file to new location without copying the data, if the source and destination locations reside within the
same logical volume.null if the data is stored in memory.protected java.io.File getTempFile()
File representing a uniquely named temporary file in the
configured repository path. The lifetime of the file is tied to the lifetime of the FileItem
instance; the file will be deleted when the instance is garbage collected.File to be used for temporary storage.public java.lang.String toString()
toString in class java.lang.Objectpublic FileItemHeaders getHeaders()
getHeaders in interface FileItemHeadersSupportpublic void setHeaders(FileItemHeaders pHeaders)
setHeaders in interface FileItemHeadersSupportpHeaders - The file items headers.Guillaume Bort & zenexity - Distributed under Apache 2 licence, without any warrantly