org.apache.hc.core5.http.io.entity

类 BufferedHttpEntity

java.lang.Object

org.apache.hc.core5.http.io.entity.HttpEntityWrapper

org.apache.hc.core5.http.io.entity.BufferedHttpEntity

所有已实现的接口:

Closeable, AutoCloseable, EntityDetails, HttpEntity

public class BufferedHttpEntity
extends HttpEntityWrapper

A wrapping entity that buffers it content if necessary. The buffered entity is always repeatable. If the wrapped entity is repeatable itself, calls are passed through. If the wrapped entity is not repeatable, the content is read into a buffer once and provided from there as often as required.

从以下版本开始:

4.0

构造器概要

构造器

构造器和说明
BufferedHttpEntity(HttpEntity entity) Creates a new buffered entity wrapper.

方法概要

限定符和类型	方法和说明
InputStream	getContent() Returns a content stream of the entity.
long	getContentLength() Returns length of the entity, if known.
boolean	isChunked() Tells that this entity does not have to be chunked.
boolean	isRepeatable() Tells that this entity is repeatable.
boolean	isStreaming() Tells whether this entity depends on an underlying stream.
void	writeTo(OutputStream outStream) Writes the entity content out to the output stream.

从类继承的方法 org.apache.hc.core5.http.io.entity.HttpEntityWrapper

close, getContentEncoding, getContentType, getTrailerNames, getTrailers, toString

从类继承的方法 java.lang.Object

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

构造器详细资料

BufferedHttpEntity

public BufferedHttpEntity(HttpEntity entity)
                   throws IOException

Creates a new buffered entity wrapper.

参数:

entity - the entity to wrap, not null

抛出:

IllegalArgumentException - if wrapped is null

IOException

方法详细资料

getContentLength

public long getContentLength()

从接口复制的说明: EntityDetails

Returns length of the entity, if known.

指定者:

getContentLength 在接口中 EntityDetails

覆盖:

getContentLength 在类中 HttpEntityWrapper

getContent

public InputStream getContent()
                       throws IOException

从接口复制的说明: HttpEntity

Returns a content stream of the entity. Repeatable entities are expected to create a new instance of InputStream for each invocation of this method and therefore can be consumed multiple times. Entities that are not repeatable are expected to return the same InputStream instance and therefore may not be consumed more than once.

If this entity belongs to an incoming HTTP message, calling InputStream.close() on the returned InputStream will try to consume the complete entity content to keep the connection alive. In cases where this is undesired, e.g. when only a small part of the content is relevant and consuming the complete entity content would be too inefficient, only the HTTP message from which this entity was obtained should be closed (if supported).

IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated after the InputStream.close() method is invoked.

指定者:

getContent 在接口中 HttpEntity

覆盖:

getContent 在类中 HttpEntityWrapper

返回:

content stream of the entity.

抛出:

IOException - if the stream could not be created

另请参阅:

HttpEntity.isRepeatable()

isChunked

public boolean isChunked()

Tells that this entity does not have to be chunked.

指定者:

isChunked 在接口中 EntityDetails

覆盖:

isChunked 在类中 HttpEntityWrapper

返回:

false

isRepeatable

public boolean isRepeatable()

Tells that this entity is repeatable.

指定者:

isRepeatable 在接口中 HttpEntity

覆盖:

isRepeatable 在类中 HttpEntityWrapper

返回:

true

writeTo

public void writeTo(OutputStream outStream)
             throws IOException

从接口复制的说明: HttpEntity

Writes the entity content out to the output stream.

IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.

指定者:

writeTo 在接口中 HttpEntity

覆盖:

writeTo 在类中 HttpEntityWrapper

参数:

outStream - the output stream to write entity content to

抛出:

IOException - if an I/O error occurs

isStreaming

public boolean isStreaming()

从接口复制的说明: HttpEntity

Tells whether this entity depends on an underlying stream. Streamed entities that read data directly from the socket should return true. Self-contained entities should return false. Wrapping entities should delegate this call to the wrapped entity.

指定者:

isStreaming 在接口中 HttpEntity

覆盖:

isStreaming 在类中 HttpEntityWrapper

返回:

true if the entity content is streamed, false otherwise