No examples for this method.
Frequently called with: [Clear]
-1
| java.lang.Object | |
| ↳ | org.apache.http.entity.HttpEntityWrapper |
 Known Direct Subclasses
|
Base class for wrapping entities. Keeps a wrappedEntity and delegates all calls to it. Implementations of wrapping entities can derive from this class and need to override only those methods that should not be delegated to the wrapped entity.
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
wrappedEntity | The wrapped entity. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Creates a new entity wrapper.
|
||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
TODO: The name of this method is misnomer.
|
||||||||||
|
|
Creates a new InputStream object of the entity.
|
||||||||||
|
|
Obtains the Content-Encoding header, if known.
|
||||||||||
|
|
Tells the length of the content, if known.
|
||||||||||
|
|
Obtains the Content-Type header, if known.
|
||||||||||
|
|
Tells about chunked encoding for this entity.
|
||||||||||
|
|
Tells if the entity is capable to produce its data more than once.
|
||||||||||
|
|
Tells whether this entity depends on an underlying stream.
|
||||||||||
|
|
Writes the entity content to the output stream.
|
||||||||||
| [Expand]
Inherited Methods
|
|||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| From class java.lang.Object
|
|||||||||||
| From interface org.apache.http.HttpEntity
|
|||||||||||
Creates a new entity wrapper.
| wrapped | the entity to wrap |
|---|
TODO: The name of this method is misnomer. It will be renamed to #finish() in the next major release.
This method is called to indicate that the content of this entity is no longer required. All entity implementations are expected to release all allocated resources as a result of this method invocation. Content streaming entities are also expected to dispose of the remaining content, if any. Wrapping entities should delegate this call to the wrapped entity.
This method is of particular importance for entities being received from a connection. The entity needs to be consumed completely in order to re-use the connection with keep-alive.
| IOException |
|---|
Creates a new InputStream object of the entity. It is a programming error to return the same InputStream object more than once. Entities that are not repeatable will throw an exception if this method is called multiple times.
| IOException |
|---|
Obtains the Content-Encoding header, if known. This is the header that should be used when sending the entity, or the one that was received with the entity. Wrapping entities that modify the content encoding should adjust this header accordingly.
null if the content encoding is unknown Tells the length of the content, if known.
Long.MAX_VALUE, a negative number is returned. Obtains the Content-Type header, if known. This is the header that should be used when sending the entity, or the one that was received with the entity. It can include a charset attribute.
null if the content type is unknown Tells about chunked encoding for this entity. The primary purpose of this method is to indicate whether chunked encoding should be used when the entity is sent. For entities that are received, it can also indicate whether the entity was received with chunked encoding.
The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
true if chunked encoding is preferred for this entity, or false if it is not Tells if the entity is capable to produce its data more than once. A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.
Tells whether this entity depends on an underlying stream. Streamed entities should return 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.
The content of a streamed entity is consumed when the stream returned by 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 otherwise Writes the entity content to the output stream.
| outstream | the output stream to write entity content to |
|---|
| IOException |
|---|