HttpData (Netty API Reference (4.1.22.Final))

All Superinterfaces:

ByteBufHolder ，java.lang.Comparable的< InterfaceHttpData >， InterfaceHttpData ， ReferenceCounted

All Known Subinterfaces:

Attribute ， FileUpload

所有已知实现类：

AbstractDiskHttpData ， AbstractHttpData ， AbstractMemoryHttpData ， DiskAttribute ， DiskFileUpload ， MemoryAttribute ， MemoryFileUpload ， MixedAttribute ， MixedFileUpload
```
public interface HttpData
extends InterfaceHttpData, ByteBufHolder
```
InterfaceHttpData的扩展接口

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.handler.codec.http.multipart.InterfaceHttpData
  InterfaceHttpData.HttpDataType

方法摘要

所有方法接口方法抽象方法
Modifier and Type	Method and Description
`void`	`addContent(ByteBuf buffer, boolean last)` 从ChannelBuffer添加内容
`void`	`checkSize(long newSize)` 检查新尺寸是否未达到允许的最大限制。
`HttpData`	`copy()` 创建此`ByteBufHolder`的深层副本。
`long`	`definedLength()` 返回HttpData的定义长度。
`void`	`delete()` 删除文件项目的底层存储，包括删除任何关联的临时磁盘文件。
`HttpData`	`duplicate()` 重复此`ByteBufHolder` 。
`byte[]`	`get()` 以字节数组的形式返回文件项目的内容。
`ByteBuf`	`getByteBuf()` 以ByteBuf的形式返回文件项目的内容
`java.nio.charset.Charset`	`getCharset()` 返回浏览器传递的字符集，如果未定义，则返回null。
`ByteBuf`	`getChunk(int length)` 从当前位置返回一个ChannelBuffer，长度读取字节数最多，从而增加了读取字节的当前位置。
`java.io.File`	`getFile()`
`long`	`getMaxSize()` 返回此HttpData的maxSize。
`java.lang.String`	`getString()` 使用默认字符编码，以String形式返回文件项目的内容。
`java.lang.String`	`getString(java.nio.charset.Charset encoding)` 使用指定的字符集，以String形式返回文件项目的内容。
`boolean`	`isCompleted()`
`boolean`	`isInMemory()` 提供有关是否从内存中读取文件内容的提示。
`long`	`length()` 返回InterfaceHttpData的字节大小
`boolean`	`renameTo(java.io.File dest)` 方便的getMethod将上传的项目写入磁盘。
`HttpData`	`replace(ByteBuf content)` 返回一个新`ByteBufHolder`包含指定`content` 。
`HttpData`	`retain()` 将参考计数增加 `1` 。
`HttpData`	`retain(int increment)` 将参考计数增加 `increment` 。
`HttpData`	`retainedDuplicate()` 重复此`ByteBufHolder` 。
`void`	`setCharset(java.nio.charset.Charset charset)` 如果已定义，请设置浏览器传递的字符集
`void`	`setContent(ByteBuf buffer)` 设置来自ChannelBuffer的内容（删除以前的任何数据）
`void`	`setContent(java.io.File file)` 设置文件中的内容（删除以前的任何数据）
`void`	`setContent(java.io.InputStream inputStream)` 设置inputStream中的内容（删除以前的任何数据）
`void`	`setMaxSize(long maxSize)` 为此HttpData设置maxSize。
`HttpData`	`touch()` 记录此对象的当前访问位置以进行调试。
`HttpData`	`touch(java.lang.Object hint)` 记录此对象的当前访问位置，并附加一些用于调试的任意信息。

Methods inherited from interface io.netty.handler.codec.http.multipart.InterfaceHttpData
getHttpDataType, getName

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface io.netty.buffer.ByteBufHolder
content

Methods inherited from interface io.netty.util.ReferenceCounted
refCnt, release, release

- 方法详细信息
  - getMaxSize
```
long getMaxSize()
```
    返回此HttpData的maxSize。
  - setMaxSize
```
void setMaxSize(long maxSize)
```
    为此HttpData设置maxSize。当达到限制时，将会引发异常。将其设置为（-1）意味着没有限制。默认情况下，从HttpDataFactory设置。
  - checkSize
```
void checkSize(long newSize)
        throws java.io.IOException
```
    检查新尺寸是否未达到允许的最大限制。该限制总是以字节计算。
    
    异常
    
    java.io.IOException
  - setContent
```
void setContent(ByteBuf buffer)
         throws java.io.IOException
```
    设置来自ChannelBuffer的内容（删除以前的任何数据）
    
    参数
    
    buffer - 必须不为null
    
    异常
    
    java.io.IOException
  - addContent
```
void addContent(ByteBuf buffer,
                boolean last)
         throws java.io.IOException
```
    从ChannelBuffer添加内容
    
    参数
    
    buffer - 除非last设置为False，否则不能为null
    
    last - 缓冲区是最后一个
    
    异常
    
    java.io.IOException
  - setContent
```
void setContent(java.io.File file)
         throws java.io.IOException
```
    设置文件中的内容（删除以前的任何数据）
    
    参数
    
    file - 必须不为null
    
    异常
    
    java.io.IOException
  - setContent
```
void setContent(java.io.InputStream inputStream)
         throws java.io.IOException
```
    设置inputStream中的内容（删除以前的任何数据）
    
    参数
    
    inputStream - 必须不为null
    
    异常
    
    java.io.IOException
  - isCompleted
```
boolean isCompleted()
```
    结果
    
    如果InterfaceHttpData已完成（所有数据均已存储），则为true
  - length
```
long length()
```
    返回InterfaceHttpData的字节大小
    
    结果
    
    InterfaceHttpData的大小
  - definedLength
```
long definedLength()
```
    返回HttpData的定义长度。如果请求中没有提供Content-Length，则定义的长度始终为0（无论在解码过程中还是在最终状态中）。如果请求中提供了Content-Length，则这是给定的长度。无论在解码期间还是在最终状态下，该值都不会改变。该方法可用于例如知道针对一个特定HttpData传输的字节量，例如一个FileUpload或任何已知的大Attribute 。
    
    结果
    
    HttpData的定义长度
  - delete
```
void delete()
```
    删除文件项目的底层存储，包括删除任何关联的临时磁盘文件。
  - get
```
byte[] get()
    throws java.io.IOException
```
    以字节数组的形式返回文件项目的内容。
    
    结果
    
    文件项目的内容为一个字节数组。
    
    异常
    
    java.io.IOException
  - getByteBuf
```
ByteBuf getByteBuf()
            throws java.io.IOException
```
    以ByteBuf的形式返回文件项目的内容
    
    结果
    
    该文件项目的内容为ByteBuf
    
    异常
    
    java.io.IOException
  - getChunk
```
ByteBuf getChunk(int length)
          throws java.io.IOException
```
    从当前位置返回一个ChannelBuffer，长度读取字节数最多，从而增加了读取字节的当前位置。一旦到达最后，它将返回一个EMPTY_BUFFER并将当前位置重置为0。
    
    结果
    
    一个用于来自当前位置的内容的ChannelBuffer或一个EMPTY_BUFFER，如果没有更多数据要返回
    
    异常
    
    java.io.IOException
  - getString
```
java.lang.String getString()
                    throws java.io.IOException
```
    使用默认字符编码，以String形式返回文件项目的内容。
    
    结果
    
    该文件项目的内容为一个字符串，使用默认的字符编码。
    
    异常
    
    java.io.IOException
  - getString
```
java.lang.String getString(java.nio.charset.Charset encoding)
                    throws java.io.IOException
```
    使用指定的字符集，以String形式返回文件项目的内容。
    
    参数
    
    encoding - 使用的字符集
    
    结果
    
    使用指定的字符集将文件项的内容作为字符串使用。
    
    异常
    
    java.io.IOException
  - setCharset
```
void setCharset(java.nio.charset.Charset charset)
```
    如果已定义，请设置浏览器传递的字符集
    
    参数
    
    charset - 要设置的字符集 - 必须不为null
  - getCharset
```
java.nio.charset.Charset getCharset()
```
    返回浏览器传递的字符集，如果未定义，则返回null。
    
    结果
    
    浏览器传递的字符集;如果未定义，则返回null。
  - renameTo
```
boolean renameTo(java.io.File dest)
          throws java.io.IOException
```
    方便的getMethod将上传的项目写入磁盘。如果前一个存在，它将被删除。一旦调用了getMethod，如果成功，新文件将不在创建原始InterfaceHttpData对象的工厂清理程序中。
    
    参数
    
    dest - 目标文件 - 必须不为空
    
    结果
    
    如果写入成功，则为真
    
    异常
    
    java.io.IOException
  - isInMemory
```
boolean isInMemory()
```
    提供有关是否从内存中读取文件内容的提示。
    
    结果
    
    如果文件内容在内存中，则为真。
  - getFile
```
java.io.File getFile()
              throws java.io.IOException
```
    结果
    
    如果此数据表示在文件中，则关联的文件
    
    异常
    
    java.io.IOException - 如果该数据不是由文件表示的
  - copy
```
HttpData copy()
```
    从接口复制的描述： ByteBufHolder
    
    创建此ByteBufHolder的深层副本。
    
    Specified by:
    
    copy接口 ByteBufHolder
  - duplicate
```
HttpData duplicate()
```
    从接口复制的描述： ByteBufHolder
    
    重复此ByteBufHolder 。请注意，这不会自动调用ByteBufHolder.retain() 。
    
    Specified by:
    
    duplicate接口 ByteBufHolder
  - retainedDuplicate
```
HttpData retainedDuplicate()
```
    从界面复制的描述： ByteBufHolder
    
    重复此ByteBufHolder 。与ByteBufHolder.duplicate()不同，此方法返回保留的副本。
    
    Specified by:
    
    retainedDuplicate在界面 ByteBufHolder
    
    另请参见：
    
    ByteBuf.retainedDuplicate()
  - replace
```
HttpData replace(ByteBuf content)
```
    从界面复制的描述： ByteBufHolder
    
    返回一个新ByteBufHolder包含指定content 。
    
    Specified by:
    
    replace在界面 ByteBufHolder
  - retain
```
HttpData retain()
```
    从界面复制的描述： ReferenceCounted
    
    将引用计数增加 1 。
    
    Specified by:
    
    retain接口 ByteBufHolder
    
    Specified by:
    
    retain接口 InterfaceHttpData
    
    Specified by:
    
    retain在界面 ReferenceCounted
  - retain
```
HttpData retain(int increment)
```
    从接口复制的描述： ReferenceCounted
    
    将参考计数增加指定的 increment 。
    
    Specified by:
    
    retain接口 ByteBufHolder
    
    Specified by:
    
    retain接口 InterfaceHttpData
    
    Specified by:
    
    retain接口 ReferenceCounted
  - touch
```
HttpData touch()
```
    从界面复制的描述： ReferenceCounted
    
    记录此对象的当前访问位置以进行调试。如果确定此物体泄漏，则通过此操作记录的信息将通过ResourceLeakDetector提供给您。此方法是touch(null)的快捷方式。
    
    Specified by:
    
    touch接口 ByteBufHolder
    
    Specified by:
    
    touch接口 InterfaceHttpData
    
    Specified by:
    
    touch接口 ReferenceCounted
  - touch
```
HttpData touch(java.lang.Object hint)
```
    从界面复制的描述： ReferenceCounted
    
    记录此对象的当前访问位置，并附加一些用于调试的任意信息。如果确定此物体泄漏，则通过此操作记录的信息将通过ResourceLeakDetector提供给您。
    
    Specified by:
    
    touch在界面 ByteBufHolder
    
    Specified by:
    
    touch接口 InterfaceHttpData
    
    Specified by:
    
    touch in interface ReferenceCounted

Interface HttpData

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.handler.codec.http.multipart.InterfaceHttpData

方法摘要

Methods inherited from interface io.netty.handler.codec.http.multipart.InterfaceHttpData

Methods inherited from interface java.lang.Comparable

Methods inherited from interface io.netty.buffer.ByteBufHolder

Methods inherited from interface 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