MixedFileUpload (Netty 4.1.109.Final API文档

java.lang.Object
- io.netty.util.AbstractReferenceCounted
- - io.netty.handler.codec.http.multipart.MixedFileUpload

所有已实现的接口:

ByteBufHolder, FileUpload, HttpData, InterfaceHttpData, ReferenceCounted, java.lang.Comparable<InterfaceHttpData>
```
public class MixedFileUpload
extends AbstractReferenceCounted
implements FileUpload
```
Mixed implementation using both in Memory and in File with a limit of size

嵌套类概要
- 从接口继承的嵌套类/接口 io.netty.handler.codec.http.multipart.InterfaceHttpData
  InterfaceHttpData.HttpDataType

构造器概要

构造器
构造器和说明
`MixedFileUpload(java.lang.String name, java.lang.String filename, java.lang.String contentType, java.lang.String contentTransferEncoding, java.nio.charset.Charset charset, long size, long limitSize)`
`MixedFileUpload(java.lang.String name, java.lang.String filename, java.lang.String contentType, java.lang.String contentTransferEncoding, java.nio.charset.Charset charset, long size, long limitSize, java.lang.String baseDir, boolean deleteOnExit)`

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`void`	`addContent(ByteBuf buffer, boolean last)` Add the content from the ChannelBuffer `ReferenceCounted.release()` ownership of `buffer` is transferred to this `HttpData`.
`void`	`checkSize(long newSize)` Check if the new size is not reaching the max limit allowed.
`int`	`compareTo(InterfaceHttpData o)`
`ByteBuf`	`content()` Return the data which is held by this `ByteBufHolder`.
`FileUpload`	`copy()` Creates a deep copy of this `ByteBufHolder`.
`protected void`	`deallocate()` Called once `AbstractReferenceCounted.refCnt()` is equals 0.
`long`	`definedLength()` Returns the defined length of the HttpData.
`void`	`delete()` Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
`FileUpload`	`duplicate()` Duplicates this `ByteBufHolder`.
`boolean`	`equals(java.lang.Object obj)`
`byte[]`	`get()` Returns the contents of the file item as an array of bytes.
`ByteBuf`	`getByteBuf()` Returns the content of the file item as a ByteBuf.
`java.nio.charset.Charset`	`getCharset()` Returns the Charset passed by the browser or null if not defined.
`ByteBuf`	`getChunk(int length)` Returns a ChannelBuffer for the content from the current position with at most length read bytes, increasing the current position of the Bytes read.
`java.lang.String`	`getContentTransferEncoding()` Returns the Content-Transfer-Encoding
`java.lang.String`	`getContentType()` Returns the content type passed by the browser or null if not defined.
`java.io.File`	`getFile()`
`java.lang.String`	`getFilename()` Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
`InterfaceHttpData.HttpDataType`	`getHttpDataType()`
`long`	`getMaxSize()` Returns the maxSize for this HttpData.
`java.lang.String`	`getName()` Returns the name of this InterfaceHttpData.
`java.lang.String`	`getString()` Returns the contents of the file item as a String, using the default character encoding.
`java.lang.String`	`getString(java.nio.charset.Charset encoding)` Returns the contents of the file item as a String, using the specified charset.
`int`	`hashCode()`
`boolean`	`isCompleted()`
`boolean`	`isInMemory()` Provides a hint as to whether or not the file contents will be read from memory.
`long`	`length()` Returns the size in byte of the InterfaceHttpData
`boolean`	`renameTo(java.io.File dest)` A convenience getMethod to write an uploaded item to disk.
`FileUpload`	`replace(ByteBuf content)` Returns a new `ByteBufHolder` which contains the specified `content`.
`FileUpload`	`retain()` Increases the reference count by `1`.
`FileUpload`	`retain(int increment)` Increases the reference count by the specified `increment`.
`FileUpload`	`retainedDuplicate()` Duplicates this `ByteBufHolder`.
`void`	`setCharset(java.nio.charset.Charset charset)` Set the Charset passed by the browser if defined
`void`	`setContent(ByteBuf buffer)` Set the content from the ChannelBuffer (erase any previous data) `ReferenceCounted.release()` ownership of `buffer` is transferred to this `HttpData`.
`void`	`setContent(java.io.File file)` Set the content from the file (erase any previous data)
`void`	`setContent(java.io.InputStream inputStream)` Set the content from the inputStream (erase any previous data)
`void`	`setContentTransferEncoding(java.lang.String contentTransferEncoding)` Set the Content-Transfer-Encoding type from String as 7bit, 8bit or binary
`void`	`setContentType(java.lang.String contentType)` Set the Content Type passed by the browser if defined
`void`	`setFilename(java.lang.String filename)` Set the original filename
`void`	`setMaxSize(long maxSize)` Set the maxSize for this HttpData.
`java.lang.String`	`toString()`
`FileUpload`	`touch()` Records the current access location of this object for debugging purposes.
`FileUpload`	`touch(java.lang.Object hint)` Records the current access location of this object with an additional arbitrary information for debugging purposes.

从类继承的方法 io.netty.util.AbstractReferenceCounted
refCnt, release, release, setRefCnt

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

从接口继承的方法 io.netty.handler.codec.http.multipart.HttpData
addContent, checkSize, definedLength, delete, get, getByteBuf, getCharset, getChunk, getFile, getMaxSize, getString, getString, isCompleted, isInMemory, length, renameTo, setCharset, setContent, setContent, setContent, setMaxSize

从接口继承的方法 io.netty.handler.codec.http.multipart.InterfaceHttpData
getHttpDataType, getName

从接口继承的方法 java.lang.Comparable
compareTo

从接口继承的方法 io.netty.buffer.ByteBufHolder
content

从接口继承的方法 io.netty.util.ReferenceCounted
refCnt, release, release

- 构造器详细资料
  - MixedFileUpload
```
public MixedFileUpload(java.lang.String name,
                       java.lang.String filename,
                       java.lang.String contentType,
                       java.lang.String contentTransferEncoding,
                       java.nio.charset.Charset charset,
                       long size,
                       long limitSize)
```
  - MixedFileUpload
```
public MixedFileUpload(java.lang.String name,
                       java.lang.String filename,
                       java.lang.String contentType,
                       java.lang.String contentTransferEncoding,
                       java.nio.charset.Charset charset,
                       long size,
                       long limitSize,
                       java.lang.String baseDir,
                       boolean deleteOnExit)
```
- 方法详细资料
  - getContentTransferEncoding
```
public java.lang.String getContentTransferEncoding()
```
    从接口复制的说明: FileUpload
    
    Returns the Content-Transfer-Encoding
    
    指定者:
    
    getContentTransferEncoding 在接口中 FileUpload
    
    返回:
    
    the Content-Transfer-Encoding
  - getFilename
```
public java.lang.String getFilename()
```
    从接口复制的说明: FileUpload
    
    Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
    
    指定者:
    
    getFilename 在接口中 FileUpload
    
    返回:
    
    the original filename
  - setContentTransferEncoding
```
public void setContentTransferEncoding(java.lang.String contentTransferEncoding)
```
    从接口复制的说明: FileUpload
    
    Set the Content-Transfer-Encoding type from String as 7bit, 8bit or binary
    
    指定者:
    
    setContentTransferEncoding 在接口中 FileUpload
  - setFilename
```
public void setFilename(java.lang.String filename)
```
    从接口复制的说明: FileUpload
    
    Set the original filename
    
    指定者:
    
    setFilename 在接口中 FileUpload
  - setContentType
```
public void setContentType(java.lang.String contentType)
```
    从接口复制的说明: FileUpload
    
    Set the Content Type passed by the browser if defined
    
    指定者:
    
    setContentType 在接口中 FileUpload
    
    参数:
    
    contentType - Content Type to set - must be not null
  - getContentType
```
public java.lang.String getContentType()
```
    从接口复制的说明: FileUpload
    
    Returns the content type passed by the browser or null if not defined.
    
    指定者:
    
    getContentType 在接口中 FileUpload
    
    返回:
    
    the content type passed by the browser or null if not defined.
  - copy
```
public FileUpload copy()
```
    从接口复制的说明: ByteBufHolder
    
    Creates a deep copy of this ByteBufHolder.
    
    指定者:
    
    copy 在接口中 ByteBufHolder
    
    指定者:
    
    copy 在接口中 FileUpload
    
    指定者:
    
    copy 在接口中 HttpData
  - duplicate
```
public FileUpload duplicate()
```
    从接口复制的说明: ByteBufHolder
    
    Duplicates this ByteBufHolder. Be aware that this will not automatically call ByteBufHolder.retain().
    
    指定者:
    
    duplicate 在接口中 ByteBufHolder
    
    指定者:
    
    duplicate 在接口中 FileUpload
    
    指定者:
    
    duplicate 在接口中 HttpData
  - retainedDuplicate
```
public FileUpload retainedDuplicate()
```
    从接口复制的说明: ByteBufHolder
    
    Duplicates this ByteBufHolder. This method returns a retained duplicate unlike ByteBufHolder.duplicate().
    
    指定者:
    
    retainedDuplicate 在接口中 ByteBufHolder
    
    指定者:
    
    retainedDuplicate 在接口中 FileUpload
    
    指定者:
    
    retainedDuplicate 在接口中 HttpData
    
    另请参阅:
    
    ByteBuf.retainedDuplicate()
  - replace
```
public FileUpload replace(ByteBuf content)
```
    从接口复制的说明: ByteBufHolder
    
    Returns a new ByteBufHolder which contains the specified content.
    
    指定者:
    
    replace 在接口中 ByteBufHolder
    
    指定者:
    
    replace 在接口中 FileUpload
    
    指定者:
    
    replace 在接口中 HttpData
  - touch
```
public FileUpload touch()
```
    从接口复制的说明: ReferenceCounted
    
    Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).
    
    指定者:
    
    touch 在接口中 ByteBufHolder
    
    指定者:
    
    touch 在接口中 FileUpload
    
    指定者:
    
    touch 在接口中 HttpData
    
    指定者:
    
    touch 在接口中 InterfaceHttpData
    
    指定者:
    
    touch 在接口中 ReferenceCounted
  - touch
```
public FileUpload touch(java.lang.Object hint)
```
    从接口复制的说明: ReferenceCounted
    
    Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.
    
    指定者:
    
    touch 在接口中 ByteBufHolder
    
    指定者:
    
    touch 在接口中 FileUpload
    
    指定者:
    
    touch 在接口中 HttpData
    
    指定者:
    
    touch 在接口中 InterfaceHttpData
    
    指定者:
    
    touch 在接口中 ReferenceCounted
  - retain
```
public FileUpload retain()
```
    从接口复制的说明: ReferenceCounted
    
    Increases the reference count by 1.
    
    指定者:
    
    retain 在接口中 ByteBufHolder
    
    指定者:
    
    retain 在接口中 FileUpload
    
    指定者:
    
    retain 在接口中 HttpData
    
    指定者:
    
    retain 在接口中 InterfaceHttpData
    
    指定者:
    
    retain 在接口中 ReferenceCounted
  - retain
```
public FileUpload retain(int increment)
```
    从接口复制的说明: ReferenceCounted
    
    Increases the reference count by the specified increment.
    
    指定者:
    
    retain 在接口中 ByteBufHolder
    
    指定者:
    
    retain 在接口中 FileUpload
    
    指定者:
    
    retain 在接口中 HttpData
    
    指定者:
    
    retain 在接口中 InterfaceHttpData
    
    指定者:
    
    retain 在接口中 ReferenceCounted
  - getMaxSize
```
public long getMaxSize()
```
    从接口复制的说明: HttpData
    
    Returns the maxSize for this HttpData.
    
    指定者:
    
    getMaxSize 在接口中 HttpData
  - setMaxSize
```
public void setMaxSize(long maxSize)
```
    从接口复制的说明: HttpData
    
    Set the maxSize for this HttpData. When limit will be reached, an exception will be raised. Setting it to (-1) means no limitation. By default, to be set from the HttpDataFactory.
    
    指定者:
    
    setMaxSize 在接口中 HttpData
  - content
```
public ByteBuf content()
```
    从接口复制的说明: ByteBufHolder
    
    Return the data which is held by this ByteBufHolder.
    
    指定者:
    
    content 在接口中 ByteBufHolder
  - checkSize
```
public void checkSize(long newSize)
               throws java.io.IOException
```
    从接口复制的说明: HttpData
    
    Check if the new size is not reaching the max limit allowed. The limit is always computed in terms of bytes.
    
    指定者:
    
    checkSize 在接口中 HttpData
    
    抛出:
    
    java.io.IOException
  - definedLength
```
public long definedLength()
```
    从接口复制的说明: HttpData
    
    Returns the defined length of the HttpData. If no Content-Length is provided in the request, the defined length is always 0 (whatever during decoding or in final state). If Content-Length is provided in the request, this is this given defined length. This value does not change, whatever during decoding or in the final state. This method could be used for instance to know the amount of bytes transmitted for one particular HttpData, for example one FileUpload or any known big Attribute.
    
    指定者:
    
    definedLength 在接口中 HttpData
    
    返回:
    
    the defined length of the HttpData
  - getCharset
```
public java.nio.charset.Charset getCharset()
```
    从接口复制的说明: HttpData
    
    Returns the Charset passed by the browser or null if not defined.
    
    指定者:
    
    getCharset 在接口中 HttpData
    
    返回:
    
    the Charset passed by the browser or null if not defined.
  - getName
```
public java.lang.String getName()
```
    从接口复制的说明: InterfaceHttpData
    
    Returns the name of this InterfaceHttpData.
    
    指定者:
    
    getName 在接口中 InterfaceHttpData
  - addContent
```
public void addContent(ByteBuf buffer,
                       boolean last)
                throws java.io.IOException
```
    从接口复制的说明: HttpData
    
    Add the content from the ChannelBuffer
    ReferenceCounted.release() ownership of buffer is transferred to this HttpData.
    
    指定者:
    
    addContent 在接口中 HttpData
    
    参数:
    
    buffer - must be not null except if last is set to False
    
    last - True of the buffer is the last one
    
    抛出:
    
    java.io.IOException
  - deallocate
```
protected void deallocate()
```
    从类复制的说明: AbstractReferenceCounted
    
    Called once AbstractReferenceCounted.refCnt() is equals 0.
    
    指定者:
    
    deallocate 在类中 AbstractReferenceCounted
  - delete
```
public void delete()
```
    从接口复制的说明: HttpData
    
    Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
    
    指定者:
    
    delete 在接口中 HttpData
  - get
```
public byte[] get()
           throws java.io.IOException
```
    从接口复制的说明: HttpData
    
    Returns the contents of the file item as an array of bytes.
    Note: this method will allocate a lot of memory, if the data is currently stored on the file system.
    
    指定者:
    
    get 在接口中 HttpData
    
    返回:
    
    the contents of the file item as an array of bytes.
    
    抛出:
    
    java.io.IOException
  - getByteBuf
```
public ByteBuf getByteBuf()
                   throws java.io.IOException
```
    从接口复制的说明: HttpData
    
    Returns the content of the file item as a ByteBuf.
    Note: this method will allocate a lot of memory, if the data is currently stored on the file system.
    
    指定者:
    
    getByteBuf 在接口中 HttpData
    
    返回:
    
    the content of the file item as a ByteBuf
    
    抛出:
    
    java.io.IOException
  - getString
```
public java.lang.String getString()
                           throws java.io.IOException
```
    从接口复制的说明: HttpData
    
    Returns the contents of the file item as a String, using the default character encoding.
    
    指定者:
    
    getString 在接口中 HttpData
    
    返回:
    
    the contents of the file item as a String, using the default character encoding.
    
    抛出:
    
    java.io.IOException
  - getString
```
public java.lang.String getString(java.nio.charset.Charset encoding)
                           throws java.io.IOException
```
    从接口复制的说明: HttpData
    
    Returns the contents of the file item as a String, using the specified charset.
    
    指定者:
    
    getString 在接口中 HttpData
    
    参数:
    
    encoding - the charset to use
    
    返回:
    
    the contents of the file item as a String, using the specified charset.
    
    抛出:
    
    java.io.IOException
  - isInMemory
```
public boolean isInMemory()
```
    从接口复制的说明: HttpData
    
    Provides a hint as to whether or not the file contents will be read from memory.
    
    指定者:
    
    isInMemory 在接口中 HttpData
    
    返回:
    
    True if the file contents is in memory.
  - length
```
public long length()
```
    从接口复制的说明: HttpData
    
    Returns the size in byte of the InterfaceHttpData
    
    指定者:
    
    length 在接口中 HttpData
    
    返回:
    
    the size of the InterfaceHttpData
  - renameTo
```
public boolean renameTo(java.io.File dest)
                 throws java.io.IOException
```
    从接口复制的说明: HttpData
    
    A convenience getMethod to write an uploaded item to disk. If a previous one exists, it will be deleted. Once this getMethod is called, if successful, the new file will be out of the cleaner of the factory that creates the original InterfaceHttpData object.
    
    指定者:
    
    renameTo 在接口中 HttpData
    
    参数:
    
    dest - destination file - must be not null
    
    返回:
    
    True if the write is successful
    
    抛出:
    
    java.io.IOException
  - setCharset
```
public void setCharset(java.nio.charset.Charset charset)
```
    从接口复制的说明: HttpData
    
    Set the Charset passed by the browser if defined
    
    指定者:
    
    setCharset 在接口中 HttpData
    
    参数:
    
    charset - Charset to set - must be not null
  - setContent
```
public void setContent(ByteBuf buffer)
                throws java.io.IOException
```
    从接口复制的说明: HttpData
    
    Set the content from the ChannelBuffer (erase any previous data)
    ReferenceCounted.release() ownership of buffer is transferred to this HttpData.
    
    指定者:
    
    setContent 在接口中 HttpData
    
    参数:
    
    buffer - must be not null
    
    抛出:
    
    java.io.IOException
  - setContent
```
public void setContent(java.io.File file)
                throws java.io.IOException
```
    从接口复制的说明: HttpData
    
    Set the content from the file (erase any previous data)
    
    指定者:
    
    setContent 在接口中 HttpData
    
    参数:
    
    file - must be not null
    
    抛出:
    
    java.io.IOException
  - setContent
```
public void setContent(java.io.InputStream inputStream)
                throws java.io.IOException
```
    从接口复制的说明: HttpData
    
    Set the content from the inputStream (erase any previous data)
    
    指定者:
    
    setContent 在接口中 HttpData
    
    参数:
    
    inputStream - must be not null
    
    抛出:
    
    java.io.IOException
  - isCompleted
```
public boolean isCompleted()
```
    指定者:
    
    isCompleted 在接口中 HttpData
    
    返回:
    
    True if the InterfaceHttpData is completed (all data are stored)
  - getHttpDataType
```
public InterfaceHttpData.HttpDataType getHttpDataType()
```
    指定者:
    
    getHttpDataType 在接口中 InterfaceHttpData
    
    返回:
    
    The HttpDataType
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - compareTo
```
public int compareTo(InterfaceHttpData o)
```
    指定者:
    
    compareTo 在接口中 java.lang.Comparable<InterfaceHttpData>
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - getChunk
```
public ByteBuf getChunk(int length)
                 throws java.io.IOException
```
    从接口复制的说明: HttpData
    
    Returns a ChannelBuffer for the content from the current position with at most length read bytes, increasing the current position of the Bytes read. Once it arrives at the end, it returns an EMPTY_BUFFER and it resets the current position to 0.
    
    指定者:
    
    getChunk 在接口中 HttpData
    
    返回:
    
    a ChannelBuffer for the content from the current position or an EMPTY_BUFFER if there is no more data to return
    
    抛出:
    
    java.io.IOException
  - getFile
```
public java.io.File getFile()
                     throws java.io.IOException
```
    指定者:
    
    getFile 在接口中 HttpData
    
    返回:
    
    the associated File if this data is represented in a file
    
    抛出:
    
    java.io.IOException - if this data is not represented by a file

类 MixedFileUpload

嵌套类概要

从接口继承的嵌套类/接口 io.netty.handler.codec.http.multipart.InterfaceHttpData

构造器概要

方法概要

从类继承的方法 io.netty.util.AbstractReferenceCounted

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

从接口继承的方法 io.netty.handler.codec.http.multipart.HttpData

从接口继承的方法 io.netty.handler.codec.http.multipart.InterfaceHttpData

从接口继承的方法 java.lang.Comparable

从接口继承的方法 io.netty.buffer.ByteBufHolder

从接口继承的方法 io.netty.util.ReferenceCounted

构造器详细资料

MixedFileUpload

MixedFileUpload

方法详细资料

getContentTransferEncoding

getFilename

setContentTransferEncoding

setFilename

setContentType

getContentType

copy

duplicate

retainedDuplicate

replace

touch

touch

retain

retain

getMaxSize

setMaxSize

content

checkSize

definedLength

getCharset

getName

addContent

deallocate

delete

get

getByteBuf

getString

getString

isInMemory

length

renameTo

setCharset

setContent

setContent

setContent

isCompleted

getHttpDataType

hashCode

equals

compareTo

toString

getChunk

getFile