Package play.data.parsing
Class ApacheMultipartParser.AutoFileItem
- java.lang.Object
-
- play.data.parsing.ApacheMultipartParser.AutoFileItem
-
- All Implemented Interfaces:
java.io.Serializable,FileItem,FileItemHeadersSupport
- Enclosing class:
- ApacheMultipartParser
public static class ApacheMultipartParser.AutoFileItem extends java.lang.Object implements FileItem
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringDEFAULT_CHARSETDefault content charset to be used when no explicit charset parameter is provided by the sender.
-
Constructor Summary
Constructors Constructor Description AutoFileItem(FileItemStream stream)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddelete()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.StringgetCharSet()Returns the content charset passed by the agent ornullif not defined.java.lang.StringgetContentType()Returns the content type passed by the agent ornullif not defined.java.lang.StringgetFieldName()Returns the name of the field in the multipart form corresponding to this file item.FileItemHeadersgetHeaders()Returns the file item headers.java.io.InputStreamgetInputStream()Returns anInputStreamthat can be used to retrieve the contents of the file.java.lang.StringgetName()Returns the original filename in the client's filesystem.java.io.OutputStreamgetOutputStream()Returns anOutputStreamthat can be used for storing the contents of the file.longgetSize()Returns the size of the file.java.io.FilegetStoreLocation()Returns theFileobject for theFileItem's data's temporary location on the disk.java.lang.StringgetString()Returns the contents of the file as a String, using the default character encoding.java.lang.StringgetString(java.lang.String charset)Returns the contents of the file as a String, using the specified encoding.protected java.io.FilegetTempFile()Creates and returns aFilerepresenting a uniquely named temporary file in the configured repository path.booleanisFormField()Determines whether or not aFileIteminstance represents a simple form field.booleanisInMemory()Provides a hint as to whether or not the file contents will be read from memory.voidsetFieldName(java.lang.String fieldName)Sets the field name used to reference this file item.voidsetFormField(boolean state)Specifies whether or not aFileIteminstance represents a simple form field.voidsetHeaders(FileItemHeaders pHeaders)Sets the file item headers.java.lang.StringtoString()voidwrite(java.io.File file)A convenience method to write an uploaded item to disk.
-
-
-
Field Detail
-
DEFAULT_CHARSET
public static final java.lang.String DEFAULT_CHARSET
Default content charset to be used when no explicit charset parameter is provided by the sender. Media subtypes of the "text" type are defined to have a default charset value of "ISO-8859-1" when received via HTTP.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AutoFileItem
public AutoFileItem(FileItemStream stream)
-
-
Method Detail
-
getInputStream
public java.io.InputStream getInputStream() throws java.io.IOExceptionReturns anInputStreamthat can be used to retrieve the contents of the file.- Specified by:
getInputStreamin interfaceFileItem- Returns:
- An
InputStreamthat can be used to retrieve the contents of the file. - Throws:
java.io.IOException- if an error occurs.
-
getContentType
public java.lang.String getContentType()
Returns the content type passed by the agent ornullif not defined.- Specified by:
getContentTypein interfaceFileItem- Returns:
- The content type passed by the agent or
nullif not defined.
-
getCharSet
public java.lang.String getCharSet()
Returns the content charset passed by the agent ornullif not defined.- Returns:
- The content charset passed by the agent or
nullif not defined.
-
getName
public java.lang.String getName()
Returns the original filename in the client's filesystem.
-
isInMemory
public boolean isInMemory()
Provides a hint as to whether or not the file contents will be read from memory.- Specified by:
isInMemoryin interfaceFileItem- Returns:
trueif the file contents will be read from memory;falseotherwise.
-
getSize
public long getSize()
Returns the size of the file.
-
get
public byte[] get()
Returns the contents of the file as an array of bytes. If the contents of the file were not yet cached in memory, they will be loaded from the disk storage and cached.
-
getString
public java.lang.String getString(java.lang.String charset) throws java.io.UnsupportedEncodingExceptionReturns the contents of the file as a String, using the specified encoding. This method usesget()to retrieve the contents of the file.
-
getString
public java.lang.String getString()
Returns the contents of the file as a String, using the default character encoding. This method usesget()to retrieve the contents of the file.
-
write
public void write(java.io.File file) throws java.lang.ExceptionA 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 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.
-
delete
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 theFileIteminstance is garbage collected, this method can be used to ensure that this is done at an earlier time, thus preserving system resources.
-
getFieldName
public java.lang.String getFieldName()
Returns the name of the field in the multipart form corresponding to this file item.- Specified by:
getFieldNamein interfaceFileItem- Returns:
- The name of the form field.
- See Also:
setFieldName(java.lang.String)
-
setFieldName
public void setFieldName(java.lang.String fieldName)
Sets the field name used to reference this file item.- Specified by:
setFieldNamein interfaceFileItem- Parameters:
fieldName- The name of the form field.- See Also:
getFieldName()
-
isFormField
public boolean isFormField()
Determines whether or not aFileIteminstance represents a simple form field.- Specified by:
isFormFieldin interfaceFileItem- Returns:
trueif the instance represents a simple form field;falseif it represents an uploaded file.- See Also:
setFormField(boolean)
-
setFormField
public void setFormField(boolean state)
Specifies whether or not aFileIteminstance represents a simple form field.- Specified by:
setFormFieldin interfaceFileItem- Parameters:
state-trueif the instance represents a simple form field;falseif it represents an uploaded file.- See Also:
isFormField()
-
getOutputStream
public java.io.OutputStream getOutputStream() throws java.io.IOExceptionReturns anOutputStreamthat can be used for storing the contents of the file.- Specified by:
getOutputStreamin interfaceFileItem- Returns:
- An
OutputStreamthat can be used for storing the contents of the file. - Throws:
java.io.IOException- if an error occurs.
-
getStoreLocation
public java.io.File getStoreLocation()
Returns theFileobject for theFileItem's data's temporary location on the disk. Note that forFileItems that have their data stored in memory, this method will returnnull. When handling large files, you can useFile.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.- Returns:
- The data file, or
nullif the data is stored in memory.
-
getTempFile
protected java.io.File getTempFile()
Creates and returns aFilerepresenting a uniquely named temporary file in the configured repository path. The lifetime of the file is tied to the lifetime of theFileIteminstance; the file will be deleted when the instance is garbage collected.- Returns:
- The
Fileto be used for temporary storage.
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
getHeaders
public FileItemHeaders getHeaders()
Returns the file item headers.- Specified by:
getHeadersin interfaceFileItemHeadersSupport- Returns:
- The file items headers.
-
setHeaders
public void setHeaders(FileItemHeaders pHeaders)
Sets the file item headers.- Specified by:
setHeadersin interfaceFileItemHeadersSupport- Parameters:
pHeaders- The file items headers.
-
-