public class FileEntity extends AbstractHttpEntity implements Cloneable
| Modifier and Type | Field and Description |
|---|---|
protected File |
file |
chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE| Constructor and Description |
|---|
FileEntity(File file)
Creates a new instance.
|
FileEntity(File file,
ContentType contentType)
Creates a new instance.
|
FileEntity(File file,
String contentType)
Deprecated.
(4.1.3)
FileEntity(File, ContentType) |
| Modifier and Type | Method and Description |
|---|---|
Object |
clone() |
InputStream |
getContent()
Returns a content stream of the entity.
|
long |
getContentLength()
Tells the length of the content, if known.
|
boolean |
isRepeatable()
Tells if the entity is capable of producing its data more than once.
|
boolean |
isStreaming()
Tells that this entity is not streaming.
|
void |
writeTo(OutputStream outStream)
Writes the entity content out to the output stream.
|
consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType, toStringprotected final File file
@Deprecated public FileEntity(File file, String contentType)
FileEntity(File, ContentType)file - The file to serve.contentType - The content type for the given file.public FileEntity(File file, ContentType contentType)
file - The file to serve.contentType - The content type for the given file.public FileEntity(File file)
file - The file to serve.public boolean isRepeatable()
HttpEntityisRepeatable in interface HttpEntitypublic long getContentLength()
HttpEntitygetContentLength in interface HttpEntityLong.MAX_VALUE,
a negative number is returned.public 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.
IMPORTANT: Please note all entity implementations must ensure that
all allocated resources are properly deallocated after
the InputStream.close() method is invoked.
getContent in interface HttpEntityIOException - if the stream could not be createdHttpEntity.isRepeatable()public void writeTo(OutputStream outStream) throws IOException
HttpEntityIMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
writeTo in interface HttpEntityoutStream - the output stream to write entity content toIOException - if an I/O error occurspublic boolean isStreaming()
isStreaming in interface HttpEntityfalsepublic Object clone() throws CloneNotSupportedException
clone in class ObjectCloneNotSupportedExceptionCopyright © 2005–2022 The Apache Software Foundation. All rights reserved.