Android
org.apache.http.entity
public class

org.apache.http.entity.HttpEntityWrapper

java.lang.Object
org.apache.http.entity.HttpEntityWrapper HttpEntity

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.

Known Direct Subclasses

Summary

Fields

protected      HttpEntity  wrappedEntity  The wrapped entity. 

Public Constructors

            HttpEntityWrapper(HttpEntity wrapped)
Creates a new entity wrapper.

Public Methods

          void  consumeContent()
TODO: The name of this method is misnomer.
          InputStream  getContent()
Creates a new InputStream object of the entity.
          Header  getContentEncoding()
Obtains the Content-Encoding header, if known.
          long  getContentLength()
Tells the length of the content, if known.
          Header  getContentType()
Obtains the Content-Type header, if known.
          boolean  isChunked()
Tells about chunked encoding for this entity.
          boolean  isRepeatable()
Tells if the entity is capable to produce 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 java.lang.Object
Methods inherited from interface org.apache.http.HttpEntity

Details

Fields

protected HttpEntity wrappedEntity

The wrapped entity.

Public Constructors

public HttpEntityWrapper(HttpEntity wrapped)

Creates a new entity wrapper.

Parameters

wrapped the entity to wrap

Public Methods

public void consumeContent()

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.

Throws

IOException

public InputStream getContent()

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.

Throws

IOException

public Header getContentEncoding()

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.

public long getContentLength()

Tells the length of the content, if known.

public Header getContentType()

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.

public boolean isChunked()

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.

public boolean isRepeatable()

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.

public boolean isStreaming()

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.

public void writeTo(OutputStream outstream)

Writes the entity content to the output stream.

Throws

IOException
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:56