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

类 FileEntity

java.lang.Object

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

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

所有已实现的接口:

Closeable, AutoCloseable, EntityDetails, HttpEntity

@Contract(threading=IMMUTABLE_CONDITIONAL)
public class FileEntity
extends AbstractHttpEntity

A self contained, repeatable entity that obtains its content from a file.

从以下版本开始:

4.0

构造器概要

构造器

构造器和说明
FileEntity(File file, ContentType contentType)
FileEntity(File file, ContentType contentType, String contentEncoding)

方法概要

限定符和类型	方法和说明
void	close()
InputStream	getContent() Returns a content stream of the entity.
long	getContentLength() Returns length of the entity, if known.
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.

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

getContentEncoding, getContentType, getTrailerNames, getTrailers, isChunked, toString, writeTo, writeTo

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

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

构造器详细资料

FileEntity

public FileEntity(File file,
                  ContentType contentType,
                  String contentEncoding)

FileEntity

public FileEntity(File file,
                  ContentType contentType)

方法详细资料

isRepeatable

public final 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

覆盖:

isRepeatable 在类中 AbstractHttpEntity

返回:

true if the entity is repeatable, false otherwise.

getContentLength

public final long getContentLength()

从接口复制的说明: EntityDetails

Returns length of the entity, if known.

getContent

public final 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.

返回:

content stream of the entity.

抛出:

IOException - if the stream could not be created

另请参阅:

HttpEntity.isRepeatable()

isStreaming

public final 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.

返回:

true if the entity content is streamed, false otherwise

close

public final void close()
                 throws IOException

抛出:

IOException