Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

BufferedHttpEntity

extends HttpEntityWrapper
java.lang.Object
   ↳ org.apache.http.entity.HttpEntityWrapper
     ↳ org.apache.http.entity.BufferedHttpEntity

Class Overview

A wrapping entity that buffers it content if necessary. The buffered entity is always repeatable. If the wrapped entity is repeatable itself, calls are passed through. If the wrapped entity is not repeatable, the content is read into a buffer once and provided from there as often as required.

Summary

[Expand]
Inherited Fields
From class org.apache.http.entity.HttpEntityWrapper
Public Constructors
BufferedHttpEntity ( HttpEntity entity)
Public Methods
InputStream getContent ()
Creates a new InputStream object of the entity.
long getContentLength ()
Tells the length of the content, if known.
boolean isChunked ()
Tells that this entity does not have to be chunked.
boolean isRepeatable ()
Tells that this entity is repeatable.
boolean isStreaming ()
Tells whether this entity depends on an underlying stream.
void writeTo ( OutputStream outstream)
Writes the entity content to the output stream.
[Expand]
Inherited Methods
From class org.apache.http.entity.HttpEntityWrapper
From class java.lang.Object
From interface org.apache.http.HttpEntity

Public Constructors

public BufferedHttpEntity ( HttpEntity entity)

Added in API level 1

Throws
IOException

Public Methods

public InputStream getContent ()

Added in API level 1

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.

Returns
  • a new input stream that returns the entity data.
Throws
IOException

public long getContentLength ()

Added in API level 1

Tells the length of the content, if known.

Returns
  • the number of bytes of the content, or a negative number if unknown. If the content length is known but exceeds Long.MAX_VALUE , a negative number is returned.

public boolean isChunked ()

Added in API level 1

Tells that this entity does not have to be chunked.

Returns
  • false

public boolean isRepeatable ()

Added in API level 1

Tells that this entity is repeatable.

Returns
  • true

public boolean isStreaming ()

Added in API level 1

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.

Returns
  • true if the entity content is streamed and not yet consumed, false otherwise

public void writeTo ( OutputStream outstream)

Added in API level 1

Writes the entity content to the output stream.

Parameters
outstream the output stream to write entity content to
Throws
IOException