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

类 NullEntity

java.lang.Object

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

所有已实现的接口:

Closeable, AutoCloseable, EntityDetails, HttpEntity

@Contract(threading=IMMUTABLE)
public final class NullEntity
extends Object
implements HttpEntity

An empty entity with no content-type. This type may be used for convenience in place of an empty ByteArrayEntity.

从以下版本开始:

5.1

字段概要

字段

限定符和类型	字段和说明
static NullEntity	INSTANCE

方法概要

限定符和类型	方法和说明
void	close()
InputStream	getContent() Returns a content stream of the entity.
String	getContentEncoding() Returns content encoding of the entity, if known.
long	getContentLength() Returns length of the entity, if known.
String	getContentType() Returns content type of the entity, if known.
Set<String>	getTrailerNames() Preliminary declaration of trailing headers.
Supplier<List<? extends Header>>	getTrailers() Returns supplier of message trailers - headers sent after message body.
boolean	isChunked() Returns chunked transfer hint for this entity.
boolean	isRepeatable() Tells if the entity is capable of producing its data more than once.
boolean	isStreaming() Tells whether this entity depends on an underlying stream.
void	writeTo(OutputStream outStream) Writes the entity content out to the output stream.

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

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

字段详细资料

INSTANCE

public static final NullEntity INSTANCE

方法详细资料

isRepeatable

public boolean isRepeatable()

从接口复制的说明: HttpEntity

Tells if the entity is capable of producing its data more than once. A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.

指定者:

isRepeatable 在接口中 HttpEntity

返回:

true if the entity is repeatable, false otherwise.

getContent

public InputStream getContent()
                       throws IOException,
                              UnsupportedOperationException

从接口复制的说明: 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

返回:

content stream of the entity.

抛出:

IOException - if the stream could not be created

UnsupportedOperationException - if entity content cannot be represented as InputStream.

另请参阅:

HttpEntity.isRepeatable()

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

参数:

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

返回:

true if the entity content is streamed, false otherwise

getTrailers

public Supplier<List<? extends Header>> getTrailers()

从接口复制的说明: HttpEntity

Returns supplier of message trailers - headers sent after message body. May return null if trailers are not available.

指定者:

getTrailers 在接口中 HttpEntity

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

抛出:

IOException

getContentLength

public long getContentLength()

从接口复制的说明: EntityDetails

Returns length of the entity, if known.

指定者:

getContentLength 在接口中 EntityDetails

getContentType

public String getContentType()

从接口复制的说明: EntityDetails

Returns content type of the entity, if known.

指定者:

getContentType 在接口中 EntityDetails

getContentEncoding

public String getContentEncoding()

从接口复制的说明: EntityDetails

Returns content encoding of the entity, if known.

指定者:

getContentEncoding 在接口中 EntityDetails

isChunked

public boolean isChunked()

从接口复制的说明: EntityDetails

Returns chunked transfer hint for this entity.

The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.

指定者:

isChunked 在接口中 EntityDetails

getTrailerNames

public Set<String> getTrailerNames()

从接口复制的说明: EntityDetails

Preliminary declaration of trailing headers.

指定者:

getTrailerNames 在接口中 EntityDetails