play.data.parsing
类 ApacheMultipartParser.AutoFileItem

java.lang.Object
  play.data.parsing.ApacheMultipartParser.AutoFileItem

所有已实现的接口：

java.io.Serializable, FileItem

包容类：

ApacheMultipartParser

public static class ApacheMultipartParser.AutoFileItem
extends java.lang.Object
implements FileItem

另请参见：

序列化表格

字段摘要

static java.lang.String

DEFAULT_CHARSET Default content charset to be used when no explicit charset parameter is provided by the sender.

构造方法摘要

ApacheMultipartParser.AutoFileItem(FileItemStream stream)

方法摘要

void	delete() Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
protected void	finalize() Removes the file contents from the temporary storage.
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.
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.
java.lang.String	toString()
void	write(java.io.File file) A convenience method to write an uploaded item to disk.

从类 java.lang.Object 继承的方法

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细信息

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.

另请参见：

常量字段值

构造方法详细信息

ApacheMultipartParser.AutoFileItem

public ApacheMultipartParser.AutoFileItem(FileItemStream stream)

方法详细信息

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Returns an InputStream that can be used to retrieve the contents of the file.

指定者：

接口 FileItem 中的 getInputStream

返回：

An InputStream that can be used to retrieve the contents of the file.

抛出：

java.io.IOException - if an error occurs.

getContentType

public java.lang.String getContentType()

Returns the content type passed by the agent or null if not defined.

指定者：

接口 FileItem 中的 getContentType

返回：

The content type passed by the agent or null if not defined.

getCharSet

public java.lang.String getCharSet()

Returns the content charset passed by the agent or null if not defined.

返回：

The content charset passed by the agent or null if not defined.

getName

public java.lang.String getName()

Returns the original filename in the client's filesystem.

指定者：

接口 FileItem 中的 getName

返回：

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.

指定者：

接口 FileItem 中的 isInMemory

返回：

true if the file contents will be read from memory; false otherwise.

getSize

public long getSize()

Returns the size of the file.

指定者：

接口 FileItem 中的 getSize

返回：

The size of the file, in bytes.

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.

指定者：

接口 FileItem 中的 get

返回：

The contents of the file as an array of bytes.

getString

public java.lang.String getString(java.lang.String charset)
                           throws java.io.UnsupportedEncodingException

Returns the contents of the file as a String, using the specified encoding. This method uses get() to retrieve the contents of the file.

指定者：

接口 FileItem 中的 getString

参数：

charset - The charset to use.

返回：

The contents of the file, as a string.

抛出：

java.io.UnsupportedEncodingException - if the requested character encoding is not available.

getString

public java.lang.String getString()

Returns the contents of the file as a String, using the default character encoding. This method uses get() to retrieve the contents of the file.

指定者：

接口 FileItem 中的 getString

返回：

The contents of the file, as a string.

To do:

Consider making this method throw UnsupportedEncodingException.

write

public void write(java.io.File file)
           throws java.lang.Exception

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 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.

指定者：

接口 FileItem 中的 write

参数：

file - The File into which the uploaded item should be stored.

抛出：

java.lang.Exception - if an error occurs.

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 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.

指定者：

接口 FileItem 中的 delete

getFieldName

public java.lang.String getFieldName()

Returns the name of the field in the multipart form corresponding to this file item.

指定者：

接口 FileItem 中的 getFieldName

返回：

The name of the form field.

另请参见：

setFieldName(java.lang.String)

setFieldName

public void setFieldName(java.lang.String fieldName)

Sets the field name used to reference this file item.

指定者：

接口 FileItem 中的 setFieldName

参数：

fieldName - The name of the form field.

另请参见：

getFieldName()

isFormField

public boolean isFormField()

Determines whether or not a FileItem instance represents a simple form field.

指定者：

接口 FileItem 中的 isFormField

返回：

true if the instance represents a simple form field; false if it represents an uploaded file.

另请参见：

setFormField(boolean)

setFormField

public void setFormField(boolean state)

Specifies whether or not a FileItem instance represents a simple form field.

指定者：

接口 FileItem 中的 setFormField

参数：

state - true if the instance represents a simple form field; false if it represents an uploaded file.

另请参见：

isFormField()

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Returns an OutputStream that can be used for storing the contents of the file.

指定者：

接口 FileItem 中的 getOutputStream

返回：

An OutputStream that can be used for storing the contensts of the file.

抛出：

java.io.IOException - if an error occurs.

getStoreLocation

public java.io.File getStoreLocation()

Returns the 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.

返回：

The data file, or null if the data is stored in memory.

finalize

protected void finalize()

Removes the file contents from the temporary storage.

覆盖：

类 java.lang.Object 中的 finalize

getTempFile

protected java.io.File getTempFile()

Creates and returns a 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.

返回：

The File to be used for temporary storage.

toString

public java.lang.String toString()

覆盖：

类 java.lang.Object 中的 toString