Android
org.apache.http.entity
public abstract class

org.apache.http.entity.AbstractHttpEntity

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

Abstract base class for entities. Provides the commonly used attributes for streamed and self-contained implementations of HttpEntity.

Known Direct Subclasses
Known Indirect Subclasses

Summary

Fields

protected      boolean  chunked  The 'chunked' flag. 
protected      Header  contentEncoding  The Content-Encoding header. 
protected      Header  contentType  The Content-Type header. 

Protected Constructors

            AbstractHttpEntity()
Protected default constructor.

Public Methods

          void  consumeContent()
Does not consume anything.
          Header  getContentEncoding()
Obtains the Content-Encoding header.
          Header  getContentType()
Obtains the Content-Type header.
          boolean  isChunked()
Obtains the 'chunked' flag.
          void  setChunked(boolean b)
Specifies the 'chunked' flag.
          void  setContentEncoding(Header contentEncoding)
Specifies the Content-Encoding header.
          void  setContentEncoding(String ceString)
Specifies the Content-Encoding header, as a string.
          void  setContentType(String ctString)
Specifies the Content-Type header, as a string.
          void  setContentType(Header contentType)
Specifies the Content-Type header.
Methods inherited from class java.lang.Object
Methods inherited from interface org.apache.http.HttpEntity

Details

Fields

protected boolean chunked

The 'chunked' flag. Returned by isChunked, unless that method is overridden.

protected Header contentEncoding

The Content-Encoding header. Returned by getContentEncoding, unless that method is overridden.

protected Header contentType

The Content-Type header. Returned by getContentType, unless that method is overridden.

Protected Constructors

protected AbstractHttpEntity()

Protected default constructor. The attributes of the created object remain null and false, respectively.

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.

Throws

IOException in case of an I/O problem
UnsupportedOperationException if a streaming subclass does not override this method

public Header getContentEncoding()

Obtains the Content-Encoding header. The default implementation returns the value of the contentEncoding attribute.

Returns

  • the Content-Encoding header, or null

public Header getContentType()

Obtains the Content-Type header. The default implementation returns the value of the contentType attribute.

Returns

  • the Content-Type header, or null

public boolean isChunked()

Obtains the 'chunked' flag. The default implementation returns the value of the chunked attribute.

Returns

  • the 'chunked' flag

public void setChunked(boolean b)

Specifies the 'chunked' flag. The default implementation sets the value of the chunked attribute.

Parameters

b the new 'chunked' flag

public void setContentEncoding(Header contentEncoding)

Specifies the Content-Encoding header. The default implementation sets the value of the contentEncoding attribute.

Parameters

contentEncoding the new Content-Encoding header, or null to unset

public void setContentEncoding(String ceString)

Specifies the Content-Encoding header, as a string. The default implementation calls setContentEncoding(Header).

Parameters

ceString the new Content-Encoding header, or null to unset

public void setContentType(String ctString)

Specifies the Content-Type header, as a string. The default implementation calls setContentType(Header).

Parameters

ctString the new Content-Type header, or null to unset

public void setContentType(Header contentType)

Specifies the Content-Type header. The default implementation sets the value of the contentType attribute.

Parameters

contentType the new Content-Encoding header, or null to unset
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48