org.apache.http.client.entity

## Class EntityBuilder

- java.lang.Object
- - org.apache.http.client.entity.EntityBuilder

-     public class EntityBuilder
      extends Object

  生成器为`HttpEntity`实例。

  该构建器的几种设置方法是互斥的。 如果多次调用以下方法，只有最后一个方法才有效果：

  - `setText(String)`
  - `setBinary(byte[])`
  - `setStream(java.io.InputStream)`
  - `setSerializable(java.io.Serializable)`
  - `setParameters(java.util.List)`
  - `setParameters(org.apache.http.NameValuePair...)`
  - `setFile(java.io.File)`
  从以下版本开始：
    4.3

- - ### 方法摘要

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `HttpEntity` | `build()` 根据当前状态创建`HttpEntity`的新实例。
    `EntityBuilder` | `chunked()` 使实体块编码。
    `static EntityBuilder` | `create()`
    `byte[]` | `getBinary()` 如果使用 `setBinary(byte[])`方法设置，则返回实体内容作为字节数组。
    `String` | `getContentEncoding()` 如果设置，返回实体的内容编码。
    `ContentType` | `getContentType()` 返回`ContentType`的实体，如果设置。
    `File` | `getFile()` 返回实体内容为`File` ，如果使用设置`setFile(java.io.File)`方法。
    `List<NameValuePair>` | `getParameters()` 如果使用 `setParameters(java.util.List)`或 `setParameters(org.apache.http.NameValuePair...)`方法设置，则返回实体内容作为参数列表。
    `Serializable` | `getSerializable()` 返回实体内容为`Serializable` ，如果使用设置`setSerializable(java.io.Serializable)`方法。
    `InputStream` | `getStream()` 返回实体内容为`InputStream` ，如果使用设置`setStream(java.io.InputStream)`方法。
    `String` | `getText()` 如果使用 `setText(String)`方法设置，则返回实体内容作为字符串。
    `EntityBuilder` | `gzipCompress()` 使实体GZIP压缩。
    `boolean` | `isChunked()` 如果实体是块编码，则返回 `true` ，否则为 `false` 。
    `boolean` | `isGzipCompress()` 返回 `true`如果实体被gzip压缩， `false`其他。
    `EntityBuilder` | `setBinary(byte[] binary)` 将实体内容设置为字节数组。
    `EntityBuilder` | `setContentEncoding(String contentEncoding)` 设置实体的内容编码。
    `EntityBuilder` | `setContentType(ContentType contentType)` 设置实体的`ContentType` 。
    `EntityBuilder` | `setFile(File file)` 将实体内容设置为`File` 。
    `EntityBuilder` | `setParameters(List<NameValuePair> parameters)` 将实体内容设置为参数列表。
    `EntityBuilder` | `setParameters(NameValuePair... parameters)` 将实体内容设置为参数列表。
    `EntityBuilder` | `setSerializable(Serializable serializable)` 将实体内容设置为`Serializable` 。
    `EntityBuilder` | `setStream(InputStream stream)` 将实体内容设置为`InputStream` 。
    `EntityBuilder` | `setText(String text)` 将实体内容设置为字符串。

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 方法详细信息

    - #### create

          public static EntityBuilder create()

    - #### getText

          public String getText()

      如果使用 `setText(String)`方法设置，则返回实体内容作为字符串。

    - #### setText

          public EntityBuilder setText(String text)

      将实体内容设置为字符串。 此方法与互斥`setBinary(byte[])` ， `setStream(java.io.InputStream)` ， `setSerializable(java.io.Serializable)` ， `setParameters(java.util.List)` ， `setParameters(org.apache.http.NameValuePair...)`种 `setFile(java.io.File)`方法。

    - #### getBinary

          public byte[] getBinary()

      如果使用 `setBinary(byte[])`方法设置，则返回实体内容作为字节数组。

    - #### setBinary

          public EntityBuilder setBinary(byte[] binary)

      将实体内容设置为字节数组。 此方法与互斥`setText(String)` ， `setStream(java.io.InputStream)` ， `setSerializable(java.io.Serializable)` ， `setParameters(java.util.List)` ， `setParameters(org.apache.http.NameValuePair...)`种 `setFile(java.io.File)`方法。

    - #### getStream

          public InputStream getStream()

      返回实体内容为`InputStream` ，如果使用设置`setStream(java.io.InputStream)`方法。

    - #### setStream

          public EntityBuilder setStream(InputStream stream)

      将实体内容设置为`InputStream` 。 此方法与互斥`setText(String)` ， `setBinary(byte[])` ， `setSerializable(java.io.Serializable)` ， `setParameters(java.util.List)` ， `setParameters(org.apache.http.NameValuePair...)`种 `setFile(java.io.File)`方法。

    - #### getParameters

          public List<NameValuePair> getParameters()

      如果使用 `setParameters(java.util.List)`或 `setParameters(org.apache.http.NameValuePair...)`方法设置，则返回实体内容作为参数列表。

    - #### setParameters

          public EntityBuilder setParameters(List<NameValuePair> parameters)

      将实体内容设置为参数列表。 此方法与互斥`setText(String)` ， `setBinary(byte[])` ， `setStream(java.io.InputStream)` ， `setSerializable(java.io.Serializable)` ， `setFile(java.io.File)`种方法。

    - #### setParameters

          public EntityBuilder setParameters(NameValuePair... parameters)

      将实体内容设置为参数列表。 此方法与互斥`setText(String)` ， `setBinary(byte[])` ， `setStream(java.io.InputStream)` ， `setSerializable(java.io.Serializable)` ， `setFile(java.io.File)`种方法。

    - #### getSerializable

          public Serializable getSerializable()

      返回实体内容为`Serializable` ，如果使用设置`setSerializable(java.io.Serializable)`方法。

    - #### setSerializable

          public EntityBuilder setSerializable(Serializable serializable)

      将实体内容设置为`Serializable` 。 此方法与互斥`setText(String)` ， `setBinary(byte[])` ， `setStream(java.io.InputStream)` ， `setParameters(java.util.List)` ， `setParameters(org.apache.http.NameValuePair...)`种 `setFile(java.io.File)`方法。

    - #### getFile

          public File getFile()

      返回实体内容为`File`如果使用`setFile(java.io.File)`方法设置。

    - #### setFile

          public EntityBuilder setFile(File file)

      将实体内容设置为`File` 。 此方法与互斥`setText(String)` ， `setBinary(byte[])` ， `setStream(java.io.InputStream)` ， `setParameters(java.util.List)` ， `setParameters(org.apache.http.NameValuePair...)`种 `setSerializable(java.io.Serializable)`方法。

    - #### getContentType

          public ContentType getContentType()

      返回`ContentType`的实体，如果设置。

    - #### setContentType

          public EntityBuilder setContentType(ContentType contentType)

      设置实体的`ContentType` 。

    - #### getContentEncoding

          public String getContentEncoding()

      如果设置，返回实体的内容编码。

    - #### setContentEncoding

          public EntityBuilder setContentEncoding(String contentEncoding)

      设置实体的内容编码。

    - #### isChunked

          public boolean isChunked()

      返回 `true`如果实体是块编码，否则为 `false` 。

    - #### chunked

          public EntityBuilder chunked()

      使实体块编码。

    - #### isGzipCompress

          public boolean isGzipCompress()

      返回 `true`如果实体被gzip压缩， `false`其他。

    - #### gzipCompress

          public EntityBuilder gzipCompress()

      使实体GZIP压缩。

    - #### build

          public HttpEntity build()

      根据当前状态创建`HttpEntity`的新实例。

Copyright © 1999–2017 The Apache Software Foundation. All rights reserved.

本帮助文档是使用 《谷歌翻译》翻译，请与英文版配合使用 by--QQ:654638585