public class EntityBuilder extends Object
HttpEntity
instances.
Several setter methods of this builder are mutually exclusive. In case of multiple invocations of the following methods only the last one will have effect:
Modifier and Type | Method and Description |
---|---|
org.apache.http.HttpEntity |
build()
Creates new instance of
HttpEntity based on the current state. |
EntityBuilder |
chunked()
Makes entity chunk coded.
|
static EntityBuilder |
create() |
byte[] |
getBinary()
Returns entity content as a byte array if set using
setBinary(byte[]) method. |
String |
getContentEncoding()
Returns content encoding of the entity, if set.
|
org.apache.http.entity.ContentType |
getContentType()
Returns
ContentType of the entity, if set. |
File |
getFile()
Returns entity content as a
File if set using
setFile(java.io.File) method. |
List<org.apache.http.NameValuePair> |
getParameters()
Returns entity content as a parameter list if set using
setParameters(java.util.List) or
setParameters(org.apache.http.NameValuePair...) methods. |
Serializable |
getSerializable()
Returns entity content as a
Serializable if set using
setSerializable(java.io.Serializable) method. |
InputStream |
getStream()
Returns entity content as a
InputStream if set using
setStream(java.io.InputStream) method. |
String |
getText()
Returns entity content as a string if set using
setText(String) method. |
EntityBuilder |
gzipCompress()
Makes entity GZIP compressed.
|
boolean |
isChunked()
Returns
true if entity is to be chunk coded, false otherwise. |
boolean |
isGzipCompress()
Returns
true if entity is to be GZIP compressed, false otherwise. |
EntityBuilder |
setBinary(byte[] binary)
Sets entity content as a byte array.
|
EntityBuilder |
setContentEncoding(String contentEncoding)
Sets content encoding of the entity.
|
EntityBuilder |
setContentType(org.apache.http.entity.ContentType contentType)
Sets
ContentType of the entity. |
EntityBuilder |
setFile(File file)
Sets entity content as a
File . |
EntityBuilder |
setParameters(List<org.apache.http.NameValuePair> parameters)
Sets entity content as a parameter list.
|
EntityBuilder |
setParameters(org.apache.http.NameValuePair... parameters)
Sets entity content as a parameter list.
|
EntityBuilder |
setSerializable(Serializable serializable)
Sets entity content as a
Serializable . |
EntityBuilder |
setStream(InputStream stream)
Sets entity content as a
InputStream . |
EntityBuilder |
setText(String text)
Sets entity content as a string.
|
public static EntityBuilder create()
public String getText()
setText(String)
method.public EntityBuilder setText(String text)
public byte[] getBinary()
setBinary(byte[])
method.public EntityBuilder setBinary(byte[] binary)
public InputStream getStream()
InputStream
if set using
setStream(java.io.InputStream)
method.public EntityBuilder setStream(InputStream stream)
InputStream
. This method is mutually
exclusive with:
public List<org.apache.http.NameValuePair> getParameters()
setParameters(java.util.List)
or
setParameters(org.apache.http.NameValuePair...)
methods.public EntityBuilder setParameters(List<org.apache.http.NameValuePair> parameters)
public EntityBuilder setParameters(org.apache.http.NameValuePair... parameters)
public Serializable getSerializable()
Serializable
if set using
setSerializable(java.io.Serializable)
method.public EntityBuilder setSerializable(Serializable serializable)
Serializable
. This method is mutually exclusive with:
public File getFile()
File
if set using
setFile(java.io.File)
method.public EntityBuilder setFile(File file)
File
. This method is mutually exclusive with:
public org.apache.http.entity.ContentType getContentType()
ContentType
of the entity, if set.public EntityBuilder setContentType(org.apache.http.entity.ContentType contentType)
ContentType
of the entity.public String getContentEncoding()
public EntityBuilder setContentEncoding(String contentEncoding)
public boolean isChunked()
true
if entity is to be chunk coded, false
otherwise.public EntityBuilder chunked()
public boolean isGzipCompress()
true
if entity is to be GZIP compressed, false
otherwise.public EntityBuilder gzipCompress()
public org.apache.http.HttpEntity build()
HttpEntity
based on the current state.Copyright © 1999–2022 The Apache Software Foundation. All rights reserved.