Apache HttpClient 4.5.14 · org.apache.http.client.entity.EntityBuilder

Modifier and Type	Field and Description
private byte[]	binary
private boolean	chunked
private String	contentEncoding
private ContentType	contentType
private File	file
private boolean	gzipCompress
private List<NameValuePair>	parameters
private Serializable	serializable
private InputStream	stream
private String	text

Access	Constructor and Description
pack-priv	EntityBuilder()

Method Summary

Modifier and Type	Method and Description
public HttpEntity	build() Creates new instance of `HttpEntity` based on the current state.
public EntityBuilder	chunked() Makes entity chunk coded.
private void	clearContent()
public static EntityBuilder	create()
public byte[]	getBinary() Returns entity content as a byte array if set using `setBinary(byte[])` method.
public String	getContentEncoding() Returns content encoding of the entity, if set.
private ContentType	getContentOrDefault(final ContentType def)
public ContentType	getContentType() Returns `ContentType` of the entity, if set.
public File	getFile() Returns entity content as a `File` if set using `setFile(java.io.File)` method.
public List<NameValuePair>	getParameters() Returns entity content as a parameter list if set using `setParameters(java.util.List)` or `setParameters(org.apache.http.NameValuePair...)` methods.
public Serializable	getSerializable() Returns entity content as a `Serializable` if set using `setSerializable(java.io.Serializable)` method.
public InputStream	getStream() Returns entity content as a `InputStream` if set using `setStream(java.io.InputStream)` method.
public String	getText() Returns entity content as a string if set using `setText(String)` method.
public EntityBuilder	gzipCompress() Makes entity GZIP compressed.
public boolean	isChunked() Returns `true` if entity is to be chunk coded, `false` otherwise.
public boolean	isGzipCompress() Returns `true` if entity is to be GZIP compressed, `false` otherwise.
public EntityBuilder	setBinary(final byte[] binary) Sets entity content as a byte array.
public EntityBuilder	setContentEncoding(final String contentEncoding) Sets content encoding of the entity.
public EntityBuilder	setContentType(final ContentType contentType) Sets `ContentType` of the entity.
public EntityBuilder	setFile(final File file) Sets entity content as a `File`.
public EntityBuilder	setParameters(final List<NameValuePair> parameters) Sets entity content as a parameter list.
public EntityBuilder	setParameters(final NameValuePair... parameters) Sets entity content as a parameter list.
public EntityBuilder	setSerializable(final Serializable serializable) Sets entity content as a `Serializable`.
public EntityBuilder	setStream(final InputStream stream) Sets entity content as a `InputStream`.
public EntityBuilder	setText(final String text) Sets entity content as a string.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

binary	back to summary
private byte[] binary

chunked	back to summary
private boolean chunked

contentEncoding	back to summary
private String contentEncoding

contentType	back to summary
private ContentType contentType

file	back to summary
private File file

gzipCompress	back to summary
private boolean gzipCompress

parameters	back to summary
private List<NameValuePair> parameters

serializable	back to summary
private Serializable serializable

stream	back to summary
private InputStream stream

text	back to summary
private String text

EntityBuilder	back to summary
pack-priv EntityBuilder()

Method Detail

build	back to summary
public HttpEntity build() Creates new instance of `HttpEntity` based on the current state.

chunked	back to summary
public EntityBuilder chunked() Makes entity chunk coded.

clearContent	back to summary
private void clearContent()

create	back to summary
public static EntityBuilder create()

getBinary	back to summary
public byte[] getBinary() Returns entity content as a byte array if set using `setBinary(byte[])` method.

getContentEncoding	back to summary
public String getContentEncoding() Returns content encoding of the entity, if set.

getContentOrDefault	back to summary
private ContentType getContentOrDefault(final ContentType def)

getContentType	back to summary
public ContentType getContentType() Returns `ContentType` of the entity, if set.

getFile	back to summary
public File getFile() Returns entity content as a `File` if set using `setFile(java.io.File)` method.

getParameters	back to summary
public List<NameValuePair> getParameters() Returns entity content as a parameter list if set using `setParameters(java.util.List)` or `setParameters(org.apache.http.NameValuePair...)` methods.

getSerializable	back to summary
public Serializable getSerializable() Returns entity content as a `Serializable` if set using `setSerializable(java.io.Serializable)` method.

getStream	back to summary
public InputStream getStream() Returns entity content as a `InputStream` if set using `setStream(java.io.InputStream)` method.

getText	back to summary
public String getText() Returns entity content as a string if set using `setText(String)` method.

gzipCompress	back to summary
public EntityBuilder gzipCompress() Makes entity GZIP compressed.

isChunked	back to summary
public boolean isChunked() Returns `true` if entity is to be chunk coded, `false` otherwise.

isGzipCompress	back to summary
public boolean isGzipCompress() Returns `true` if entity is to be GZIP compressed, `false` otherwise.

setBinary back to summary

setBinary	back to summary
public EntityBuilder setBinary(final byte[] binary) Sets entity content as a byte array. This method is mutually exclusive with: `setText(String)` `setStream(java.io.InputStream)` `setSerializable(java.io.Serializable)` `setParameters(java.util.List)` `setParameters(org.apache.http.NameValuePair...)` `setFile(java.io.File)`

public EntityBuilder setBinary(final byte[] binary)

Sets entity content as a byte array. This method is mutually exclusive with:

setContentEncoding	back to summary
public EntityBuilder setContentEncoding(final String contentEncoding) Sets content encoding of the entity.

setContentType	back to summary
public EntityBuilder setContentType(final ContentType contentType) Sets `ContentType` of the entity.

setFile back to summary

setFile	back to summary
public EntityBuilder setFile(final File file) Sets entity content as a `File`. This method is mutually exclusive with: `setText(String)` `setBinary(byte[])` `setStream(java.io.InputStream)` `setParameters(java.util.List)` `setParameters(org.apache.http.NameValuePair...)` `setSerializable(java.io.Serializable)`

public EntityBuilder setFile(final File file)

Sets entity content as a File. This method is mutually exclusive with:

setParameters back to summary

setParameters	back to summary
public EntityBuilder setParameters(final List<NameValuePair> parameters) Sets entity content as a parameter list. This method is mutually exclusive with: `setText(String)` `setBinary(byte[])` `setStream(java.io.InputStream)` `setSerializable(java.io.Serializable)` `setFile(java.io.File)`

public EntityBuilder setParameters(final List<NameValuePair> parameters)

Sets entity content as a parameter list. This method is mutually exclusive with:

setParameters back to summary

setParameters	back to summary
public EntityBuilder setParameters(final NameValuePair... parameters) Sets entity content as a parameter list. This method is mutually exclusive with: `setText(String)` `setBinary(byte[])` `setStream(java.io.InputStream)` `setSerializable(java.io.Serializable)` `setFile(java.io.File)`

public EntityBuilder setParameters(final NameValuePair... parameters)

Sets entity content as a parameter list. This method is mutually exclusive with:

setSerializable back to summary

setSerializable	back to summary
public EntityBuilder setSerializable(final Serializable serializable) Sets entity content as a `Serializable`. This method is mutually exclusive with: `setText(String)` `setBinary(byte[])` `setStream(java.io.InputStream)` `setParameters(java.util.List)` `setParameters(org.apache.http.NameValuePair...)` `setFile(java.io.File)`

public EntityBuilder setSerializable(final Serializable serializable)

Sets entity content as a Serializable. This method is mutually exclusive with:

setStream back to summary

setStream	back to summary
public EntityBuilder setStream(final InputStream stream) Sets entity content as a `InputStream`. This method is mutually exclusive with: `setText(String)` `setBinary(byte[])` `setSerializable(java.io.Serializable)` `setParameters(java.util.List)` `setParameters(org.apache.http.NameValuePair...)` `setFile(java.io.File)`

public EntityBuilder setStream(final InputStream stream)

Sets entity content as a InputStream. This method is mutually exclusive with:

setText back to summary

setText	back to summary
public EntityBuilder setText(final String text) Sets entity content as a string. This method is mutually exclusive with: `setBinary(byte[])` `setStream(java.io.InputStream)` `setSerializable(java.io.Serializable)` `setParameters(java.util.List)` `setParameters(org.apache.http.NameValuePair...)` `setFile(java.io.File)`

public EntityBuilder setText(final String text)

Sets entity content as a string. This method is mutually exclusive with:

public Class EntityBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail