@Contract(threading=IMMUTABLE_CONDITIONAL) public class FileEntity extends AbstractHttpEntity
| Constructor and Description |
|---|
FileEntity(File file,
ContentType contentType) |
FileEntity(File file,
ContentType contentType,
String contentEncoding) |
| Modifier and Type | Method and Description |
|---|---|
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.
|
getContentEncoding, getContentType, getTrailerNames, getTrailers, isChunked, toString, writeTo, writeTopublic FileEntity(File file, ContentType contentType, String contentEncoding)
public FileEntity(File file, ContentType contentType)
public final boolean isRepeatable()
HttpEntityisRepeatable in interface HttpEntityisRepeatable in class AbstractHttpEntitypublic final long getContentLength()
EntityDetailspublic final InputStream getContent() throws IOException
HttpEntityRepeatable 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.
IOException - if the stream could not be createdHttpEntity.isRepeatable()public final boolean isStreaming()
HttpEntitytrue. Self-contained entities should return
false. Wrapping entities should delegate this call
to the wrapped entity.true if the entity content is streamed,
false otherwisepublic final void close()
throws IOException
IOExceptionCopyright © 2005–2021 The Apache Software Foundation. All rights reserved.