NettyUploadDiskFileItem (bayberry core 0.0.2 API)

java.lang.Object
- top.bayberry.core.http.nettyWebServer.NettyUploadDiskFileItem

所有已实现的接口:

Serializable, org.apache.commons.fileupload.FileItem, org.apache.commons.fileupload.FileItemHeadersSupport
```
public class NettyUploadDiskFileItem
extends Object
implements org.apache.commons.fileupload.FileItem
```
另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`static String`	`DEFAULT_CHARSET` Default content charset to be used when no explicit charset parameter is provided by the sender.
`static String`	`SERIALIZABLE_PROPERTY` Although it implements `Serializable`, a DiskFileItem can actually only be deserialized, if this System property is true.

构造器概要

构造器
构造器和说明
`NettyUploadDiskFileItem(String fieldName, String contentType, boolean isFormField, String fileName, int sizeThreshold, File repository, String UID)` Constructs a new `DiskFileItem` instance.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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.
`String`	`getCharSet()` Returns the content charset passed by the agent or `null` if not defined.
`String`	`getContentType()` Returns the content type passed by the agent or `null` if not defined.
`String`	`getFieldName()` Returns the name of the field in the multipart form corresponding to this file item.
`org.apache.commons.fileupload.FileItemHeaders`	`getHeaders()` Returns the file item headers.
`InputStream`	`getInputStream()` Returns an `InputStream` that can be used to retrieve the contents of the file.
`String`	`getName()` Returns the original filename in the client's filesystem.
`OutputStream`	`getOutputStream()` Returns an `OutputStream` that can be used for storing the contents of the file.
`long`	`getSize()` Returns the size of the file.
`File`	`getStoreLocation()` Returns the `File` object for the `FileItem`'s data's temporary location on the disk.
`String`	`getString()` Returns the contents of the file as a String, using the default character encoding.
`String`	`getString(String charset)` Returns the contents of the file as a String, using the specified encoding.
`protected 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(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(org.apache.commons.fileupload.FileItemHeaders pHeaders)` Sets the file item headers.
`String`	`toString()` Returns a string representation of this object.
`void`	`write(File file)` A convenience method to write an uploaded item to disk.

从类继承的方法 java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - SERIALIZABLE_PROPERTY
```
public static final String SERIALIZABLE_PROPERTY
```
    Although it implements Serializable, a DiskFileItem can actually only be deserialized, if this System property is true.
  - DEFAULT_CHARSET
```
public static final 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.
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - NettyUploadDiskFileItem
```
public NettyUploadDiskFileItem(String fieldName,
                               String contentType,
                               boolean isFormField,
                               String fileName,
                               int sizeThreshold,
                               File repository,
                               String UID)
```
    Constructs a new DiskFileItem instance.
    
    参数:
    
    fieldName - The name of the form field.
    
    contentType - The content type passed by the browser or null if not specified.
    
    isFormField - Whether or not this item is a plain form field, as opposed to a file upload.
    
    fileName - The original filename in the user's filesystem, or null if not specified.
    
    sizeThreshold - The threshold, in bytes, below which items will be retained in memory and above which they will be stored as a file.
    
    repository - The data repository, which is the directory in which files will be created, should the item size exceed the threshold.
- 方法详细资料
  - getInputStream
```
public InputStream getInputStream()
                           throws IOException
```
    Returns an InputStream that can be used to retrieve the contents of the file.
    
    指定者:
    
    getInputStream 在接口中 org.apache.commons.fileupload.FileItem
    
    返回:
    
    An InputStream that can be used to retrieve the contents of the file.
    
    抛出:
    
    IOException - if an error occurs.
  - getContentType
```
public String getContentType()
```
    Returns the content type passed by the agent or null if not defined.
    
    指定者:
    
    getContentType 在接口中 org.apache.commons.fileupload.FileItem
    
    返回:
    
    The content type passed by the agent or null if not defined.
  - getCharSet
```
public 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 String getName()
```
    Returns the original filename in the client's filesystem.
    
    指定者:
    
    getName 在接口中 org.apache.commons.fileupload.FileItem
    
    返回:
    
    The original filename in the client's filesystem.
    
    抛出:
    
    org.apache.commons.fileupload.InvalidFileNameException - The file name contains a NUL character, which might be an indicator of a security attack. If you intend to use the file name anyways, catch the exception and use InvalidFileNameException.getName().
  - isInMemory
```
public boolean isInMemory()
```
    Provides a hint as to whether or not the file contents will be read from memory.
    
    指定者:
    
    isInMemory 在接口中 org.apache.commons.fileupload.FileItem
    
    返回:
    
    true if the file contents will be read from memory; false otherwise.
  - getSize
```
public long getSize()
```
    Returns the size of the file.
    
    指定者:
    
    getSize 在接口中 org.apache.commons.fileupload.FileItem
    
    返回:
    
    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.
    
    指定者:
    
    get 在接口中 org.apache.commons.fileupload.FileItem
    
    返回:
    
    The contents of the file as an array of bytes.
  - getString
```
public String getString(String charset)
                 throws 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.
    
    指定者:
    
    getString 在接口中 org.apache.commons.fileupload.FileItem
    
    参数:
    
    charset - The charset to use.
    
    返回:
    
    The contents of the file, as a string.
    
    抛出:
    
    UnsupportedEncodingException - if the requested character encoding is not available.
  - getString
```
public 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. TODO Consider making this method throw UnsupportedEncodingException.
    
    指定者:
    
    getString 在接口中 org.apache.commons.fileupload.FileItem
    
    返回:
    
    The contents of the file, as a string.
  - write
```
public void write(File file)
           throws 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.
    
    指定者:
    
    write 在接口中 org.apache.commons.fileupload.FileItem
    
    参数:
    
    file - The File into which the uploaded item should be stored.
    
    抛出:
    
    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.
    
    指定者:
    
    delete 在接口中 org.apache.commons.fileupload.FileItem
  - getFieldName
```
public String getFieldName()
```
    Returns the name of the field in the multipart form corresponding to this file item.
    
    指定者:
    
    getFieldName 在接口中 org.apache.commons.fileupload.FileItem
    
    返回:
    
    The name of the form field.
    
    另请参阅:
    
    setFieldName(String)
  - setFieldName
```
public void setFieldName(String fieldName)
```
    Sets the field name used to reference this file item.
    
    指定者:
    
    setFieldName 在接口中 org.apache.commons.fileupload.FileItem
    
    参数:
    
    fieldName - The name of the form field.
    
    另请参阅:
    
    getFieldName()
  - isFormField
```
public boolean isFormField()
```
    Determines whether or not a FileItem instance represents a simple form field.
    
    指定者:
    
    isFormField 在接口中 org.apache.commons.fileupload.FileItem
    
    返回:
    
    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.
    
    指定者:
    
    setFormField 在接口中 org.apache.commons.fileupload.FileItem
    
    参数:
    
    state - true if the instance represents a simple form field; false if it represents an uploaded file.
    
    另请参阅:
    
    isFormField()
  - getOutputStream
```
public OutputStream getOutputStream()
                             throws IOException
```
    Returns an OutputStream that can be used for storing the contents of the file.
    
    指定者:
    
    getOutputStream 在接口中 org.apache.commons.fileupload.FileItem
    
    返回:
    
    An OutputStream that can be used for storing the contensts of the file.
    
    抛出:
    
    IOException - if an error occurs.
  - getStoreLocation
```
public 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(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.
    
    覆盖:
    
    finalize 在类中 Object
  - getTempFile
```
protected 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 String toString()
```
    Returns a string representation of this object.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    a string representation of this object.
  - getHeaders
```
public org.apache.commons.fileupload.FileItemHeaders getHeaders()
```
    Returns the file item headers.
    
    指定者:
    
    getHeaders 在接口中 org.apache.commons.fileupload.FileItemHeadersSupport
    
    返回:
    
    The file items headers.
  - setHeaders
```
public void setHeaders(org.apache.commons.fileupload.FileItemHeaders pHeaders)
```
    Sets the file item headers.
    
    指定者:
    
    setHeaders 在接口中 org.apache.commons.fileupload.FileItemHeadersSupport
    
    参数:
    
    pHeaders - The file items headers.

类 NettyUploadDiskFileItem

字段概要

构造器概要

方法概要

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

字段详细资料

SERIALIZABLE_PROPERTY

DEFAULT_CHARSET

构造器详细资料

NettyUploadDiskFileItem

方法详细资料

getInputStream

getContentType

getCharSet

getName

isInMemory

getSize

get

getString

getString

write

delete

getFieldName

setFieldName

isFormField

setFormField

getOutputStream

getStoreLocation

finalize

getTempFile

toString

getHeaders

setHeaders