Class Overview
A generic streamed entity being received on a connection.
Summary
|
[Expand]
Inherited Methods |
From class org.apache.http.entity.AbstractHttpEntity
|
From class java.lang.Object
|
Object
|
clone()
Returns a new instance of the same class as the receiver, whose slots
have been filled in with the values in the slots of the receiver.
|
|
boolean
|
equals(Object o)
Compares the argument to the receiver, and returns true if they represent
the same object using a class specific comparison.
|
|
void
|
finalize()
Called by the virtual machine when there are no longer any (non-weak)
references to the receiver.
|
|
final
Class<? extends Object>
|
getClass()
Returns the unique instance of java.lang.Class which represents the class
of the receiver.
|
|
int
|
hashCode()
Returns an integer hash code for the receiver.
|
|
final
void
|
notify()
Causes one thread which is wait ing on the receiver to be
made ready to run.
|
|
final
void
|
notifyAll()
Causes all threads which are wait ing on the receiver to
be made ready to run.
|
|
String
|
toString()
Returns a string containing a concise, human-readable description of the
receiver.
|
|
final
void
|
wait(long time, int frac)
Causes the thread which sent this message to be made not ready to run
either pending some change in the receiver (as indicated by
notify or notifyAll) or the expiration of
the timeout.
|
|
final
void
|
wait(long time)
Causes the thread which sent this message to be made not ready to run
either pending some change in the receiver (as indicated by
notify or notifyAll) or the expiration of
the timeout.
|
|
final
void
|
wait()
Causes the thread which sent this message to be made not ready to run
pending some change in the receiver (as indicated by notify
or notifyAll).
|
|
From interface org.apache.http.HttpEntity
|
abstract
void
|
consumeContent()
TODO: The name of this method is misnomer.
|
|
abstract
InputStream
|
getContent()
Creates a new InputStream object of the entity.
|
|
abstract
Header
|
getContentEncoding()
Obtains the Content-Encoding header, if known.
|
|
abstract
long
|
getContentLength()
Tells the length of the content, if known.
|
|
abstract
Header
|
getContentType()
Obtains the Content-Type header, if known.
|
|
abstract
boolean
|
isChunked()
Tells about chunked encoding for this entity.
|
|
abstract
boolean
|
isRepeatable()
Tells if the entity is capable to produce its data more than once.
|
|
abstract
boolean
|
isStreaming()
Tells whether this entity depends on an underlying stream.
|
|
abstract
void
|
writeTo(OutputStream outstream)
Writes the entity content to the output stream.
|
|
Public Constructors
public
BasicHttpEntity
()
Creates a new basic entity.
The content is initially missing, the content length
is set to a negative number.
Public Methods
public
void
consumeContent
()
Does not consume anything.
The default implementation does nothing if
isStreaming
returns false, and throws an exception
if it returns true.
This removes the burden of implementing
an empty method for non-streaming entities.
Obtains the content, once only.
Returns
- the content, if this is the first call to this method
since setContent has been called
public
long
getContentLength
()
public
boolean
isRepeatable
()
Tells that this entity is not repeatable.
public
boolean
isStreaming
()
public
void
setContent
(InputStream instream)
Parameters
| instream
| the stream to return with the next call to
getContent
|
public
void
setContentLength
(long len)
Specifies the length of the content.
Parameters
| len
| the number of bytes in the content, or
a negative number to indicate an unknown length
|