@Contract(threading=IMMUTABLE_CONDITIONAL) public class FileEntity extends AbstractHttpEntity
This class contains immutable attributes
but subclasses may contain
additional immutable or mutable attributes.
Constructor and Description |
---|
FileEntity(File file,
ContentType contentType)
Constructs a new instance with the given attributes kept as immutable.
|
FileEntity(File file,
ContentType contentType,
String contentEncoding)
Constructs a new instance with the given attributes kept as immutable.
|
Modifier and Type | Method and Description |
---|---|
void |
close() |
InputStream |
getContent()
Gets a content stream of the entity.
|
long |
getContentLength()
Gets length of this entity, if known.
|
boolean |
isRepeatable()
Tests if the entity is capable of producing its data more than once.
|
boolean |
isStreaming()
Tests whether this entity depends on an underlying stream.
|
getContentEncoding, getContentType, getTrailerNames, getTrailers, isChunked, toString, writeTo, writeTo
public FileEntity(File file, ContentType contentType, String contentEncoding)
The new instance:
file
- The message body contents will be set from this file.contentType
- The content-type, may be null.contentEncoding
- The content encoding string, may be null.public FileEntity(File file, ContentType contentType)
The new instance:
file
- The message body contents will be set from this file.contentType
- The content-type, may be null.public final boolean isRepeatable()
This implementation always returns false
.
This implementation always returns true
.
isRepeatable
in interface HttpEntity
isRepeatable
in class AbstractHttpEntity
public final long getContentLength()
This implementation returns the underlying file's current file length.
0
.public final InputStream getContent() throws IOException
HttpEntity
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.
IOException
- if the stream could not be createdHttpEntity.isRepeatable()
public final boolean isStreaming()
true
. Self-contained entities should return
false
. Wrapping entities should delegate this call
to the wrapped entity.
This implementation always returns false
.
true
if the entity content is streamed,
false
otherwisepublic final void close() throws IOException
This implementation is a no-op.
IOException
Copyright © 2005–2021 The Apache Software Foundation. All rights reserved.