HttpData (Netty 4.1.109.Final API文档 - 即时通讯网(52im.net))

所有超级接口:

ByteBufHolder, java.lang.Comparable<InterfaceHttpData>, InterfaceHttpData, ReferenceCounted

所有已知子接口:

Attribute, FileUpload

所有已知实现类:

AbstractDiskHttpData, AbstractHttpData, AbstractMemoryHttpData, DiskAttribute, DiskFileUpload, MemoryAttribute, MemoryFileUpload, MixedAttribute, MixedFileUpload
```
public interface HttpData
extends InterfaceHttpData, ByteBufHolder
```
Extended interface for InterfaceHttpData

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

方法概要

All Methods Instance Methods Abstract 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.
`HttpData`	`copy()` Creates a deep copy of this `ByteBufHolder`.
`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.
`HttpData`	`duplicate()` Duplicates this `ByteBufHolder`.
`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.io.File`	`getFile()`
`long`	`getMaxSize()` Returns the maxSize for this HttpData.
`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.
`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.
`HttpData`	`replace(ByteBuf content)` Returns a new `ByteBufHolder` which contains the specified `content`.
`HttpData`	`retain()` Increases the reference count by `1`.
`HttpData`	`retain(int increment)` Increases the reference count by the specified `increment`.
`HttpData`	`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`	`setMaxSize(long maxSize)` Set the maxSize for this HttpData.
`HttpData`	`touch()` Records the current access location of this object for debugging purposes.
`HttpData`	`touch(java.lang.Object hint)` Records the current access location of this object with an additional arbitrary information for debugging purposes.

从接口继承的方法 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

- 方法详细资料
  - getMaxSize
```
long getMaxSize()
```
    Returns the maxSize for this HttpData.
  - setMaxSize
```
void setMaxSize(long maxSize)
```
    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.
  - checkSize
```
void checkSize(long newSize)
        throws java.io.IOException
```
    Check if the new size is not reaching the max limit allowed. The limit is always computed in terms of bytes.
    
    抛出:
    
    java.io.IOException
  - setContent
```
void setContent(ByteBuf buffer)
         throws java.io.IOException
```
    Set the content from the ChannelBuffer (erase any previous data)
    ReferenceCounted.release() ownership of buffer is transferred to this HttpData.
    
    参数:
    
    buffer - must be not null
    
    抛出:
    
    java.io.IOException
  - addContent
```
void addContent(ByteBuf buffer,
                boolean last)
         throws java.io.IOException
```
    Add the content from the ChannelBuffer
    ReferenceCounted.release() ownership of buffer is transferred to this 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
  - setContent
```
void setContent(java.io.File file)
         throws java.io.IOException
```
    Set the content from the file (erase any previous data)
    
    参数:
    
    file - must be not null
    
    抛出:
    
    java.io.IOException
  - setContent
```
void setContent(java.io.InputStream inputStream)
         throws java.io.IOException
```
    Set the content from the inputStream (erase any previous data)
    
    参数:
    
    inputStream - must be not null
    
    抛出:
    
    java.io.IOException
  - isCompleted
```
boolean isCompleted()
```
    返回:
    
    True if the InterfaceHttpData is completed (all data are stored)
  - length
```
long length()
```
    Returns the size in byte of the InterfaceHttpData
    
    返回:
    
    the size of the InterfaceHttpData
  - definedLength
```
long definedLength()
```
    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.
    
    返回:
    
    the defined length of the HttpData
  - delete
```
void delete()
```
    Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
  - get
```
byte[] get()
    throws java.io.IOException
```
    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.
    
    返回:
    
    the contents of the file item as an array of bytes.
    
    抛出:
    
    java.io.IOException
  - getByteBuf
```
ByteBuf getByteBuf()
            throws java.io.IOException
```
    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.
    
    返回:
    
    the content of the file item as a ByteBuf
    
    抛出:
    
    java.io.IOException
  - getChunk
```
ByteBuf getChunk(int length)
          throws java.io.IOException
```
    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.
    
    返回:
    
    a ChannelBuffer for the content from the current position or an EMPTY_BUFFER if there is no more data to return
    
    抛出:
    
    java.io.IOException
  - getString
```
java.lang.String getString()
                    throws java.io.IOException
```
    Returns the contents of the file item as a String, using the default character encoding.
    
    返回:
    
    the contents of the file item as a String, using the default character encoding.
    
    抛出:
    
    java.io.IOException
  - getString
```
java.lang.String getString(java.nio.charset.Charset encoding)
                    throws java.io.IOException
```
    Returns the contents of the file item as a String, using the specified charset.
    
    参数:
    
    encoding - the charset to use
    
    返回:
    
    the contents of the file item as a String, using the specified charset.
    
    抛出:
    
    java.io.IOException
  - setCharset
```
void setCharset(java.nio.charset.Charset charset)
```
    Set the Charset passed by the browser if defined
    
    参数:
    
    charset - Charset to set - must be not null
  - getCharset
```
java.nio.charset.Charset getCharset()
```
    Returns the Charset passed by the browser or null if not defined.
    
    返回:
    
    the Charset passed by the browser or null if not defined.
  - renameTo
```
boolean renameTo(java.io.File dest)
          throws java.io.IOException
```
    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.
    
    参数:
    
    dest - destination file - must be not null
    
    返回:
    
    True if the write is successful
    
    抛出:
    
    java.io.IOException
  - isInMemory
```
boolean isInMemory()
```
    Provides a hint as to whether or not the file contents will be read from memory.
    
    返回:
    
    True if the file contents is in memory.
  - getFile
```
java.io.File getFile()
              throws java.io.IOException
```
    返回:
    
    the associated File if this data is represented in a file
    
    抛出:
    
    java.io.IOException - if this data is not represented by a file
  - copy
```
HttpData copy()
```
    从接口复制的说明: ByteBufHolder
    
    Creates a deep copy of this ByteBufHolder.
    
    指定者:
    
    copy 在接口中 ByteBufHolder
  - duplicate
```
HttpData duplicate()
```
    从接口复制的说明: ByteBufHolder
    
    Duplicates this ByteBufHolder. Be aware that this will not automatically call ByteBufHolder.retain().
    
    指定者:
    
    duplicate 在接口中 ByteBufHolder
  - retainedDuplicate
```
HttpData retainedDuplicate()
```
    从接口复制的说明: ByteBufHolder
    
    Duplicates this ByteBufHolder. This method returns a retained duplicate unlike ByteBufHolder.duplicate().
    
    指定者:
    
    retainedDuplicate 在接口中 ByteBufHolder
    
    另请参阅:
    
    ByteBuf.retainedDuplicate()
  - replace
```
HttpData replace(ByteBuf content)
```
    从接口复制的说明: ByteBufHolder
    
    Returns a new ByteBufHolder which contains the specified content.
    
    指定者:
    
    replace 在接口中 ByteBufHolder
  - retain
```
HttpData retain()
```
    从接口复制的说明: ReferenceCounted
    
    Increases the reference count by 1.
    
    指定者:
    
    retain 在接口中 ByteBufHolder
    
    指定者:
    
    retain 在接口中 InterfaceHttpData
    
    指定者:
    
    retain 在接口中 ReferenceCounted
  - retain
```
HttpData retain(int increment)
```
    从接口复制的说明: ReferenceCounted
    
    Increases the reference count by the specified increment.
    
    指定者:
    
    retain 在接口中 ByteBufHolder
    
    指定者:
    
    retain 在接口中 InterfaceHttpData
    
    指定者:
    
    retain 在接口中 ReferenceCounted
  - touch
```
HttpData 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 在接口中 InterfaceHttpData
    
    指定者:
    
    touch 在接口中 ReferenceCounted
  - touch
```
HttpData 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 在接口中 InterfaceHttpData
    
    指定者:
    
    touch 在接口中 ReferenceCounted

接口 HttpData

嵌套类概要

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

方法概要

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

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

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

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

方法详细资料

getMaxSize

setMaxSize

checkSize

setContent

addContent

setContent

setContent

isCompleted

length

definedLength

delete

get

getByteBuf

getChunk

getString

getString

setCharset

getCharset

renameTo

isInMemory

getFile

copy

duplicate

retainedDuplicate

replace

retain

retain

touch

touch