|
||||||||||
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.SerializableEntity
public class SerializableEntity
A streamed entity that obtains its content from a Serializable
.
The content obtained from the Serializable
instance can
optionally be buffered in a byte array in order to make the
entity self-contained and repeatable.
Field Summary |
---|
Fields inherited from class org.apache.http.entity.AbstractHttpEntity |
---|
chunked, contentEncoding, contentType |
Constructor Summary | |
---|---|
SerializableEntity(Serializable ser,
boolean bufferize)
Creates new instance of this class. |
Method Summary | |
---|---|
InputStream |
getContent()
Creates a new InputStream object 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 whether this entity depends on an underlying stream. |
void |
writeTo(OutputStream outstream)
Writes the entity content to the output stream. |
Methods inherited from class org.apache.http.entity.AbstractHttpEntity |
---|
consumeContent, 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 SerializableEntity(Serializable ser, boolean bufferize) throws IOException
ser
- inputbufferize
- tells whether the content should be
stored in an internal buffer
IOException
- in case of an I/O errorMethod Detail |
---|
public InputStream getContent() throws IOException, IllegalStateException
HttpEntity
repeatable
will throw an exception if this method is called multiple times.
IOException
- if the stream could not be created
IllegalStateException
- if this entity is not repeatable and the stream
has already been obtained previouslypublic long getContentLength()
HttpEntity
Long.MAX_VALUE
,
a negative number is returned.public boolean isRepeatable()
HttpEntity
public 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 writeTo(OutputStream outstream) throws IOException
HttpEntity
outstream
- the output stream to write entity content to
IOException
- if an I/O error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |