|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.http.entity.AbstractHttpEntity
org.apache.http.entity.BasicHttpEntity
public class BasicHttpEntity
A generic streamed, non-repeatable entity that obtains its content
from an InputStream
.
Field Summary |
---|
Fields inherited from class org.apache.http.entity.AbstractHttpEntity |
---|
chunked, contentEncoding, contentType |
Constructor Summary | |
---|---|
BasicHttpEntity()
Creates a new basic entity. |
Method Summary | |
---|---|
void |
consumeContent()
Does not consume anything. |
InputStream |
getContent()
Obtains the content, once only. |
long |
getContentLength()
Tells the length of the content, if known. |
boolean |
isRepeatable()
Tells that this entity is not repeatable. |
boolean |
isStreaming()
Tells whether this entity depends on an underlying stream. |
void |
setContent(InputStream instream)
Specifies the content. |
void |
setContentLength(long len)
Specifies the length of the content. |
void |
writeTo(OutputStream outstream)
Writes the entity content to the output stream. |
Methods inherited from class org.apache.http.entity.AbstractHttpEntity |
---|
getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BasicHttpEntity()
Method Detail |
---|
public long getContentLength()
HttpEntity
Long.MAX_VALUE
,
a negative number is returned.public InputStream getContent() throws IllegalStateException
setContent
has been called
IllegalStateException
- if the content has been obtained before, or
has not yet been providedpublic boolean isRepeatable()
false
public void setContentLength(long len)
len
- the number of bytes in the content, or
a negative number to indicate an unknown lengthpublic void setContent(InputStream instream)
instream
- the stream to return with the next call to
getContent
public void writeTo(OutputStream outstream) throws IOException
HttpEntity
outstream
- the output stream to write entity content to
IOException
- if an I/O error occurspublic boolean isStreaming()
HttpEntity
true
until the
content has been consumed, false
afterwards.
Self-contained entities should return false
.
Wrapping entities should delegate this call to the wrapped entity.
getContent
has been read to EOF,
or after consumeContent
has been called.
If a streamed entity can not detect whether the stream has been
read to EOF, it should return true
until
consumeContent
is called.
true
if the entity content is streamed and
not yet consumed, false
otherwisepublic void consumeContent() throws IOException
AbstractHttpEntity
isStreaming
returns false
, and throws an exception
if it returns true
.
This removes the burden of implementing
an empty method for non-streaming entities.
consumeContent
in interface HttpEntity
consumeContent
in class AbstractHttpEntity
IOException
- in case of an I/O problem
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |